v1

latestOpenAPI 3.1.02026-08-04127114.4 KB

Webhook Configurations

List Webhook Configurations

Retrieve all webhook configurations for your client. Configurations are organized into:

default: Configurations without a tenant_id that apply to your client's default callback URL
tenants: Tenant-specific configurations organized by tenant_id

get/webhook-configurations

Response

Successfully retrieved webhook configurations.

Example response

{
  "webhook_configurations": {
    "client": [
      {
        "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"
      }
    ],
    "by_tenant": {
      "TEN-123456": [
        {
          "id": 2,
          "client_id": "your-client-id",
          "tenant_id": "TEN-123456",
          "webhook_type": "ENRICHMENT_DATA",
          "callback_url": "https://tenant-specific.com/webhooks/enrichment",
          "created_at": "2024-01-15T11:00:00.000Z",
          "updated_at": "2024-01-15T11:00:00.000Z"
        }
      ]
    }
  }
}