v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB

Webhooks

List webhooks

Returns all webhooks for the client. Filter by enabled or type to narrow the result set. Use GET /v6/webhooks/built for the fully evaluated runtime form. Webhooks are outbound HTTP callbacks Extole fires when specific platform events occur.

get/v6/webhooks

Query parameters

enabledboolean nullable

type'CLIENT' | 'GENERIC' | 'PARTNER' | 'REWARD' nullable

Response

Successful response

Example response

[
  {
    "client_key_id": "handlebars@buildtime:{{clientKeyId}}",
    "created_at": "2025-10-24T02:00:00-07:00",
    "default_method": "handlebars@buildtime:{{defaultMethod}}",
    "description": "handlebars@buildtime:{{description}}",
    "enabled": "handlebars@buildtime:{{enabled}}",
    "name": "handlebars@buildtime:{{name}}",
    "request": "handlebars@buildtime:{{request}}",
    "response_handler": "handlebars@buildtime:{{responseHandler}}",
    "retry_intervals": [
      "PT42S"
    ],
    "updated_at": "2025-10-24T02:00:00-07:00",
    "url": "handlebars@buildtime:{{url}}"
  }
]