Sign in

v1

latestOpenAPI 3.1.02026-08-04127114.4 KB
Webhook Configurations

Create or Update Webhook Configuration

Create a new webhook configuration or update an existing one. Your client_id and tenant_id are automatically inferred from the bearer token on this request. To set up a webhook for a specific tenant, please ensure that the bearer token on this request as a tenant_id claim. If your bearer token lacks a tenant_id, the webhook will be created for your single-tenant environment.

  • If a configuration already exists for the same client/tenant/webhook_type combination, it will be updated.
  • If tenant_id is provided, your client must have a relationship with that tenant.
  • Omit tenant_id to set the default callback URL for your client.
put/webhook-configurations

Request body

webhook_type'ENRICHMENT_DATA' | 'ENRICHMENT_NOTIFICATION' | 'USER_TAGS_DATA' | 'USER_TAGS_NOTIFICATION' | 'INSIGHTS' required

The type of webhook to configure:

  • ENRICHMENT_DATA: Data-rich Transaction Enrichment webhooks (full payload)
  • ENRICHMENT_NOTIFICATION: Non-data-rich Enrichment webhooks (notification only, fetch data from the /cleanup/{batch_request_id} endpoint)
  • USER_TAGS_DATA: Data-rich User Tags webhooks (full payload)
  • USER_TAGS_NOTIFICATION: Non-data-rich User Tags webhooks (notification only)
  • INSIGHTS: Finsights/insights webhooks
callback_urlstring uri required

Valid HTTPS URL for webhook delivery.

Example request

{
  "callback_url": "https://your-server.com/webhooks/enrichment"
}

Response

Webhook configuration created or updated successfully.

Example response

{
  "webhook_configuration": {
    "id": 1,
    "client_id": "your-client-id",
    "tenant_id": "TEN-123456",
    "callback_url": "https://your-server.com/webhooks/enrichment",
    "created_at": "2024-01-15T10:00:00.000Z",
    "updated_at": "2024-01-15T10:00:00.000Z"
  }
}