Rather than polling the Truework API for changes, you can arrange for us to
POST request to a URL you provide whenever certain events occur.
There are a few important things to note:
- Truework will only send webhook requests over HTTPS.
- Each webhook instance you create is associated with a token. This token is included in all requests made by that hook.
- Tokens can be retrieved from the webhooks section of your API settings.
- You should check the
X-Truework-Tokenheader included with each webhook request and reject any request whose token does not correspond to the one shown for that hook on the settings page.
Webhook requests always have the following fields:
|hook||Metadata about the webhook|
|data||[many]||A payload specific to the event type|
|event||string||A unique string which identifies the event which triggered this hook|
|target||string||The URL to which the hook's payload is sent|
Fired when one of your Verification requests changes.
|state||The new state of the verification request|
|metadata||JSON||Custom metadata belonging to the verification request|