Webhooks

Create Webhook

Registers a new webhook URL to receive notifications for verification events. Users can optionally specify which events to subscribe to using the 'events' array. Supports verification.completed (when verification finishes) and verification.historical (when historical employment data becomes available) events. If events are not specified, the webhook subscribes to all available events by default.

post/webhooks

Request

Base URL
https://api.burodeingresos.com
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/burodeingresos/apis/bur-de-ingresos-api/docs/webhooks/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

descriptionstring

Description of the webhook.

endpoint_urlstring uri required

The URL to send the webhook notifications to.

eventsstring[]

Array of event types to subscribe to. If not provided, defaults to all available events.

Example request

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

Response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.