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

# List built webhooks

`GET /v6/webhooks/built`

Returns all webhooks in their fully evaluated (built) runtime form, with all evaluatable fields resolved. Supports finer filtering than the source list: `name`, `include_archived`, `limit`, and `offset` are only available on this endpoint. Use this when you need effective endpoint URLs and headers.

## Query parameters

- `enabled` boolean, nullable
- `type` 'CLIENT' | 'GENERIC' | 'PARTNER' | 'REWARD', nullable
- `name` string, nullable
- `include_archived` boolean, nullable
- `limit` integer, nullable
- `offset` integer, nullable

## Response `200`

Successful response

- BuiltWebhookResponse[]
  - union — webhook after buildtime evaluation. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, and `retry_intervals` are already evaluated.
    - object — client webhook after buildtime evaluation. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, and `retry_intervals` are already evaluated.
      - `client_key_id` string, required
      - `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` string, required
      - `description` string, required
      - `enabled` boolean, required
      - `id` string, required
      - `name` string, required
      - `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 [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 [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` Duration[], required
      - `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` string, required
    - object — generic webhook after buildtime evaluation. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, and `retry_intervals` are already evaluated.
      - `client_key_id` string, required
      - `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` string, required
      - `description` string, required
      - `enabled` boolean, required
      - `id` string, required
      - `name` string, required
      - `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 [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 [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` Duration[], required
      - `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` string, required
    - object — partner webhook after buildtime evaluation. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, `retry_intervals`, and `response_body_handler` are already evaluated.
      - `client_key_id` string, required
      - `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` string, required
      - `description` string, required
      - `enabled` boolean, required
      - `id` string, required
      - `name` string, required
      - `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 [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 [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` Duration[], required
      - `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` string, required
      - `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 [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 — reward webhook after buildtime evaluation. Fields `name`, `url`, `client_key_id`, `request`, `response_handler`, `enabled`, `description`, `default_method`, and `retry_intervals` are already evaluated.
      - `client_key_id` string, required
      - `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` string, required
      - `description` string, required
      - `enabled` boolean, required
      - `id` string, required
      - `name` string, required
      - `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 [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 [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` Duration[], required
      - `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` string, required
      - `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)