Skip to main content

Configuring a Webhook

As verifications get processed, they pass through a number of states. Each time a state transition occurs, Truework can generate a webhook to notify you of the new state. This can be used to trigger any processing that depends on the verification having reached a certain state, without the need for polling.

Webhook Payload

For more information regarding the webhook payload, see the webhooks reference page.

Creating a Webhook#

To create webhook, navigate to your settings page. Find the "API Settings โ€” Production" card and expand the Webhook section by clicking the "Edit" button. Then, select the "Verification Request Status Changed" event from the event dropdown, and enter the URL to which the webhook should be sent. Click "Create" to configure the webhook.

Webhook Token#

Every webhook event that is sent will include the "Token" value displayed next to your webhook in the X-Truework-Token header. You should reject any webhook event whose token header does not match.

Deleting a Webhook#

To delete a webhook, simply press the "Delete" button next to the webhook you wish to delete. Ensure any webhook you delete is not in use, since although you can create a new webhook for the same URL the token value will differ.

Sandbox Webhooks#

To create or delete webhooks in the sandbox environment, follow the above instructions on the "API Settings โ€” Sandbox" card. You can use a webhook logger like Webhook.site to inspect the webhook payload.