A web hook is a configurable function that sends an HTTP callback to an endpoint you specify when triggered by a particular event in Advance.
For example, you can set up a web hook to notify an endpoint in your own web application when a user completes a new work item version.
In this topic Hide
Web hooks enable Advance to notify your own web application when specific events occur in Advance. This is useful if you have an application that needs to perform an action based on the status of an entity in Advance. For example, you may have an application that must be notified when Advance creates new documents for a work item, so it can download those documents and save them to a document management system.
To work with Advance web hooks, your application must have an endpoint to which Advance can send data about the event. When the event occurs, the web hook sends a set of JSON data to your endpoint. For example, the data for a New Work Item Version Complete event includes the work item ID, name, the user that created the work item version, and the URL from which you can download the work item's assembled documents.
Your application must also manage access tokens, so that you can provide a token to Advance. Advance uses this token when sending event data to your application's endpoint, so that your application can authenticate the request.
You can create a new web hook in the Advance UI application. You must be an integrations administrator to manage web hooks. Creating a web hook is a prerequisite for receiving data from a web hook in your own application.
See Receiving Data from a Web Hook for a code example.