Creating a Web Hook

Note: only users with the Integration Administrator user role can manage web hooks.

You can create a web hook in the Web Hooks section of HotDocs Advance, accessed through the Configuration pane.

Prerequisites

• Your own web application
• An endpoint in that application to which you want to send event data
• An access token provided by your application; this is used by Advance to authenticate requests sent to your application endpoint

To create a web hook

1. In the Administration pane, click Manage web Hooks
2. In the upper-right corner of the screen, click Create new web hook.
3. Enter the following web hook details:
• Name (required) – the web hook's name
• URL (required) – the URL for the endpoint to which you want Advance to send event data
• Token (required) – an access token, provided by your application; this is sent in the Authorization header of the response sent to your application endpoint from Advance. You should always authenticate responses from Advance in your own application, using this token.
• Event type (required) – select an event for the web hook from the following options:
• New Work Item Version Complete – sends event data when a user completes a new work item version
• Active Status – either Active or Inactive; inactive web hooks do not send event data to your endpoint
• Untrusted SSL certificates – either Block untrusted SSL (default) or Accept untrusted SSL; accepting untrusted SSL allows the web hook to send data over HTTPS even when the SSL certificate is untrusted.
4. Click Create.

The new web hook appears in the Web hooks list.

Next steps

• Editing a Web Hook
• Activating or Deactivating a Web Hook
• Deleting a Web Hook