Watchlist update webhook

Watchlists supports continuous updates for a session if you subscribed to continuous updates through the API. When the search has updated security information, the Global Watchlists webhook asynchronously sends a notification to your callback URL.

The ref and search_id fields in the notification are identifiers assigned when the initial search was performed. You can use either field to retrieve the new search result with the Get updated watchlist result endpoint.

Configure the webhook

To configure your callback URL:

In Dashboard, go to Configuration > Webhooks.
Scroll down and click Generate New.
Enter a Name for the webhook.
Use the Type drop-down to select Watchlist update webhook url.
Enter your URL.
You can choose to Override Custom Headers and Authentication.
Click Save.

For more information, see the webhook overview.

Endpoint details

Incode sends a POST request to the endpoint you configured:

POST https://{client-defined-url}

Request

The webhook sends the following payload when triggered.

{
  "interviewId": "",
  "ref": "",
  "search_id": ""
}

Field	Description
`interviewId`	Identifier of the session the search belongs to.
`ref`	Reference number received when the search was created.
`search_id`	Search ID received when the search was created.

If you are authenticating your webhook requests, the webhook includes the Authorization header with the OAuth 2.0 bearer token:

Authorization: Bearer <ACCESS_TOKEN>

Any additional custom headers you configured are included as well.

Response

To prevent the retry policy from resending the same notification, make sure your endpoint returns one of the following:

Status code 204 No Content
Status code 200 OK with a Content-Type of application/json, for example { "success": true }

{
  "success": true
}