latestOpenAPI 3.0.32026-07-242644125.9 KB

59e48cdbdd84

Webhooks

List Webhooks

Retrieves a list of all registered webhooks.

get/webhooks

Response

The list of webhook details.

idstring uuid

Unique identifier for the webhook.

company_idstring uuid

Company identifier owning the webhook.

descriptionstring

Description of the webhook.

endpoint_urlstring uri

URL to send the webhook notifications to.

secret_keystring

A secret key used to verify the signature in the X-Signature header of the webhook, ensuring that the webhook request originates from the Income Bureau.

is_activeboolean

Whether the webhook is active.

eventsstring[]

Array of event types this webhook is subscribed to.

created_atstring date-time

Timestamp when the webhook was created.

updated_atstring date-time

Timestamp when the webhook was last updated.

Example response

[
  {
    "events": [
      "verification.completed",
      "verification.historical"
    ]
  }
]