Webhooks

Get Webhook

Retrieves a specific webhook by its ID.

get/webhooks/{webhook_id}

Path parameters

webhook_idstring uuid required

The unique identifier of the webhook.

Response

The 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"
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.