Configuration: Webhooks Tab
Learn more about webhooks
Webhooks are event notifications. They let your organization's application know when a specific event happens on the Incode platform or when a process initiated by a user is completed (also known as a callback). Your application can then take action based on the notification.
Webhooks are asynchronous. That means the communication is only from the Incode platform to your application. You must configure them if you want to use them.
The following list shows webhooks currently offered by Incode:
- Onboarding status webhook: Triggered every time an Onboarding Session status changes. Learn more.
- Videoselfie uploaded webhook: Triggered when the video selfie recording file becomes available. Learn more.
- Third party async retries webhook
- Watchlist updated webhook: Triggered when a global watchlist result is updated. Learn more.
- Work history callback: Triggered after a work history search for a user has been processed. This webhook is exclusive to Mexico. Learn more.
- Proof of payment callback: Triggered after payment proof validation for a user has been processed. This webhook is exclusive to Mexico. Learn more.
- Face Authentication: Triggered when a face authentication either succeeds or fails. Learn more.
- Session Started: Triggered when any session from a Flow or Workflow starts. Learn more.
- Session Failed: Triggered when any session from a Flow or Workflow fails. Learn more.
- Session Succeeded: Triggered when any session from a Flow or Workflow succeeds. Learn more.
- Session Pending Review: Triggered when a session from a Flow or Workflow requires manual review. Learn more.
The following webhooks have been offered in the past but are now deprecated:
- INE scraping webhook: Provided INE scraping results.
- Authentication webhooks: Were available for 1:1 and 1:N. Contained information about the login attempt, the identities which could match the face reported by the login, and the interview which best matches the biometric of the face used to login.
Webhook configurations
In the Webhook configurations table, you can see these fields for each configured webhook.
| Field | Description |
|---|---|
| ID | Unique identifier assigned by Incode to the webhook configuration |
| Type | The name of the webhook as shown in the drop-down when the webhook was configured (for example, Onboarding Status Webhook URL) |
| URL | The URL to which webhook notifications are sent, as provided when the webhook was configured |
| Actions | Provides icons so you can Edit or Delete the configured webhook. |
Configure general webhook settings
The settings you configure in this section of the Webhooks tab apply to all your webhooks.
General webhook settings
| Field | Description |
|---|---|
| Authentication URL (Optional) | Only needed if you have configured webhook authorization using OIDC. This URL is provided to you by Incode when you set up OIDC authorization. |
| Client ID (Optional) | Only needed if you have configured webhook authorization using OIDC. This value, also known as a client secret, is provided to you by Incode when you set up OIDC authorization. |
| Secret Key (Optional) | Only needed if you have configured webhook authorization using OIDC. This value is provided to you by Incode when you set up OIDC authorization. |
| Client Authentication (Required) | Select one of the following from the drop-down: Send as Basic Auth Header or Send client credentials in body |
| Scopes (Optional) | Only needed if you have configured webhook authorization using OIDC. |
| Webhook Custom Headers (Optional) | You can create custom headers that your endpoint receives as part of webhook notifications. You can create more than one header, but all headers are sent for all webhooks. Dynamic values are not supported. Click Add to expose the following fields: Custom Header Key and Custom Header Value. |
Steps
- Navigate to Dashboard Configuration.
- Click Webhooks at the top of the page.
- If you want to use authentication, enter values in Authentication URL, Client ID, and Secret Key.
- For Client Authentication, select a value from the drop-down.
- For Scopes, enter values if needed.
- If you want to use custom headers, click Add and enter values in Custom Header Name and Custom Header Value.
- Click Update settings.
Configure new webhook
- Navigate to Dashboard Configuration.
- Click Webhooks at the top of the page.
- Scroll down and click Generate new in the lower right corner.
- Use the drop-down to select the Type of webhook you want to configure.
- For URL, enter the URL you want this webhook to use. Only one URL per webhook is supported. If you need to receive the webhook notification at more than one endpoint, you will need to broadcast it internally after initial receipt at this URL.
Edit existing webhook settings
- Navigate to Dashboard Configuration.
- Click Webhooks at the top of the page.
- In the Webhook configurations table, locate the webhook you want to change and click Edit.
- Enter new values as needed. Click Save.
Delete existing webhook
- Navigate to Dashboard Configuration.
- Click Webhooks at the top of the page.
- In the Webhook configurations table, locate the webhook you want to delete and click Delete.
- In the confirmation dialog, click Confirm.