Webhooks

Description

For jobs that run asynchronously, webhooks provide an easy push mechanism for transmitting data from the Attestr platform to the customer's system. Customers do not need to submit a request while using Webhooks. Simply map a URL, and the Attestr platform will trigger it once the data is available.

Event Types

When one of the events listed below occurs, we send an HTTP POST request to the webhook's defined URL, along with the payload JSON, which varies depending on the type of event.

async.completed

This is triggered on successful completion of asynchronous eKYC API operation.

async.errored

This is invoked if the asynchronous eKYC API runs into errors while processing.

flowx.completed

For hosted on-boarding flows, this is triggered when user initiates a device session and successfully completes all the stages configured in the eKYC flow.

flowx.errored

This is triggered if the on-boarding flow runs into unrecoverable errors introduced either at the system level or due to user provided data.

flowx.skipped

If the user skips the on-boarding flow during execution, this event is triggered.

factx.query

This event is triggered when a follow up query is posted on a background check profile. Refer to Collect Additional Data API for more details related to Factx query notification type.

Registering For Webhooks

Visit webhooks dashboard page and click on the 'New Webhook' button.

Provide a URL for the webhook. Https URL is recommended for enhanced security.
The platform generates a default Authorization token, which is displayed on the site. If desired, it can be modified to a different value. The token should be kept in a safe place. While invoking the webhook, Attestr will pass this token as a basic authorization request header. HeaderName Authorization HeaderValue Basic <token>
Select the events from the list.
Click submit to register the webhook.

Update Webhook

To update webhook status, registerd URL, authorization token or list of events, visit the webhooks dashboard page and click on the link.

Event Payload

Because different API actions have different outputs, the event payload differs depending on the API used. For further information on event payloads, please see the relevant API documentation.

Retry and Timeout

Webhook events from Attestr are only triggered once and have a 5-second timeout. Within 5 seconds, the registered webhook URL must return a 200 success response. It's possible that events are sent out of order. If your system does not respond to the event within 5 seconds, you can still use the GetAsyncResponse API for async.completed and async.errored events, as well as the ExecutionResult API for flowx events.

Last updated on