Sign in

v1

latestOpenAPI 3.0.32026-07-242644125.9 KB
Webhooks

Update Webhook

Updates an existing webhook's configuration using the provided parameters. This operation allows changes to the webhook's URL, activation status, description, event subscriptions, and authentication method (JWT, custom headers, or token endpoint). Event subscriptions can be modified by providing a new 'events' array, which completely replaces the existing subscriptions. Authentication details must match the selected method's required structure.

patch/webhooks/{webhook_id}

Path parameters

webhook_idstring uuid required

The unique identifier of the webhook to update.

Request body

descriptionstring

Description of the webhook.

endpoint_urlstring uri required

The URL to send the webhook notifications to.

is_activeboolean required
eventsstring[]

Array of event types to subscribe to. Replaces existing event subscriptions.

Example request

{
  "description": "Production verification notifications",
  "endpoint_url": "https://yourapi.com/webhook/handle",
  "events": [
    "verification.completed",
    "verification.historical"
  ]
}

Response

Webhook updated successfully.

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