---
title: "List webhooks"
method: GET
path: "/v6/webhooks"
tags: ["Webhooks"]
---

# List webhooks

`GET /v6/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.

## Query parameters

- `enabled` boolean, nullable
- `type` 'CLIENT' | 'GENERIC' | 'PARTNER' | 'REWARD', nullable

## Response `200`

Successful response

- WebhookResponse[]
  - union
    - object — Stored client webhook definition. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, and `retry_intervals` are unevaluated and appear in buildtime-evaluatable form.
      - `client_key_id` union, required — The client key id as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Literal client key id
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `component_ids` string[], required
      - `component_references` ComponentReferenceResponse[], required
        - `component_id` string
        - `socket_names` string[]
      - `created_at` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `default_method` union, required — The default method as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Literal description
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `enabled` union, required — The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
        - boolean — Literal enabled
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `id` string, required
      - `name` union, required — The name as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `request` union, required — The request as configured: a literal value, or an expression (type:string) when defined dynamically.
        - object — Literal request
          - `body` string, nullable, required
          - `headers` object, required
          - `method` string, required
          - `url` string, required
          - `urlTemplateParameters` object, required
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Handlebars expression with [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).
        - string — Javascript expression with [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).
      - `response_handler` union, required — if no webhook response status is provided, we will retry non 2xx webhook requests
        - string — Literal response handler
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Handlebars expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).
        - string — Javascript expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).
      - `retry_intervals` union, required — The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically.
        - Duration[] — Literal retry intervals
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `tags` string[], required
      - `type` 'CLIENT', required
      - `updated_at` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `url` union, required — The url as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Literal url
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
    - object — Stored generic webhook definition. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, and `retry_intervals` are unevaluated and appear in buildtime-evaluatable form.
      - `client_key_id` union, required — The client key id as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Literal client key id
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `component_ids` string[], required
      - `component_references` ComponentReferenceResponse[], required
        - `component_id` string
        - `socket_names` string[]
      - `created_at` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `default_method` union, required — The default method as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Literal description
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `enabled` union, required — The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
        - boolean — Literal enabled
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `id` string, required
      - `name` union, required — The name as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `request` union, required — The request as configured: a literal value, or an expression (type:string) when defined dynamically.
        - object — Literal request
          - `body` string, nullable, required
          - `headers` object, required
          - `method` string, required
          - `url` string, required
          - `urlTemplateParameters` object, required
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Handlebars expression with [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).
        - string — Javascript expression with [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).
      - `response_handler` union, required — if no webhook response status is provided, we will retry non 2xx webhook requests
        - string — Literal response handler
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Handlebars expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).
        - string — Javascript expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).
      - `retry_intervals` union, required — The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically.
        - Duration[] — Literal retry intervals
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `tags` string[], required
      - `type` 'GENERIC', required
      - `updated_at` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `url` union, required — The url as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Literal url
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
    - object — Stored partner webhook definition. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, `retry_intervals`, and `response_body_handler` are unevaluated and appear in buildtime-evaluatable form.
      - `client_key_id` union, required — The client key id as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Literal client key id
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `component_ids` string[], required
      - `component_references` ComponentReferenceResponse[], required
        - `component_id` string
        - `socket_names` string[]
      - `created_at` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `default_method` union, required — The default method as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Literal description
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `enabled` union, required — The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
        - boolean — Literal enabled
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `id` string, required
      - `name` union, required — The name as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `request` union, required — The request as configured: a literal value, or an expression (type:string) when defined dynamically.
        - object — Literal request
          - `body` string, nullable, required
          - `headers` object, required
          - `method` string, required
          - `url` string, required
          - `urlTemplateParameters` object, required
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Handlebars expression with [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).
        - string — Javascript expression with [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).
      - `response_handler` union, required — if no webhook response status is provided, we will retry non 2xx webhook requests
        - string — Literal response handler
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Handlebars expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).
        - string — Javascript expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).
      - `retry_intervals` union, required — The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically.
        - Duration[] — Literal retry intervals
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `tags` string[], required
      - `type` 'PARTNER', required
      - `updated_at` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `url` union, required — The url as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Literal url
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `response_body_handler` union, required — The response body handler as configured: a literal value, or an expression (type:string) when defined dynamically.
        - object — Literal response body handler
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Handlebars expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).
        - string — Javascript expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).
    - object — Stored reward webhook definition. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, and `retry_intervals` are unevaluated and appear in buildtime-evaluatable form.
      - `client_key_id` union, required — The client key id as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Literal client key id
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `component_ids` string[], required
      - `component_references` ComponentReferenceResponse[], required
        - `component_id` string
        - `socket_names` string[]
      - `created_at` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `default_method` union, required — The default method as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Literal description
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `enabled` union, required — The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
        - boolean — Literal enabled
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `id` string, required
      - `name` union, required — The name as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `request` union, required — The request as configured: a literal value, or an expression (type:string) when defined dynamically.
        - object — Literal request
          - `body` string, nullable, required
          - `headers` object, required
          - `method` string, required
          - `url` string, required
          - `urlTemplateParameters` object, required
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Handlebars expression with [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).
        - string — Javascript expression with [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts).
      - `response_handler` union, required — if no webhook response status is provided, we will retry non 2xx webhook requests
        - string — Literal response handler
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Handlebars expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).
        - string — Javascript expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts).
      - `retry_intervals` union, required — The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically.
        - Duration[] — Literal retry intervals
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `tags` string[], required
      - `type` 'REWARD', required
      - `updated_at` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `url` union, required — The url as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Literal url
        - string — Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
        - string — Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts).
      - `filters` RewardWebhookFilterResponse[], required
        - `created_at` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
        - `id` string, required
        - `type` 'EXPRESSION' | 'STATE' | 'SUPPLIER' | 'TAGS', required
        - `updated_at` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `403` — Forbidden
- `415` — Unsupported Media Type
- `429` — Too Many Requests

---

[API](https://skmtc.net/extole/apis/integration-api-server-to-extole.md) · [All operations](https://skmtc.net/extole/apis/integration-api-server-to-extole/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extole/integration-api-server-to-extole/revisions/c16e62e66755/schema)