> ## Documentation Index > Fetch the complete documentation index at: https://doc.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a webhook > Applies a partial update to the supplied webhook. Only the fields present in the body are changed; omitted fields are left intact. Returns the persisted webhook after the update. Returns `400 webhook_not_found` if the id does not exist. ## OpenAPI ````yaml /api-reference/management.json put /v6/webhooks/{webhook_id} openapi: 3.0.1 info: description: >- Configuration endpoints for the Extole platform: campaigns, components, audiences, persons, rewards, reporting, integrations setup, and administrative tooling. title: Management API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Audiences - name: Authentication - name: Batch Jobs - name: Blocks - name: Campaigns - name: Components - name: Components Settings - name: Domains - name: Email - name: Erasure - name: Event Streams - name: File Validation Monitors - name: Optout - name: Profiles - name: Promotion Links - name: Report Schedules - name: Report Types - name: Reports - name: Reward Suppliers - name: Security Keys - name: Settings - name: User Notifications - name: User Subscriptions - name: Users - name: Webhooks paths: /v6/webhooks/{webhook_id}: put: tags: - Webhooks summary: Update a webhook description: >- Applies a partial update to the supplied webhook. Only the fields present in the body are changed; omitted fields are left intact. Returns the persisted webhook after the update. Returns `400 webhook_not_found` if the id does not exist. operationId: updateWebhook parameters: - description: The id of the webhook to be updated. in: path name: webhook_id required: true schema: type: string requestBody: content: application/json: example: client_key_id: {} component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name default_method: default_method description: description enabled: true name: name request: body: body headers: headers_key: - headers_key method: method url: url urlTemplateParameters: urlTemplateParameters_key: urlTemplateParameters_key response_body_handler: response_body_handler_key: {} response_handler: response_handler tags: - tag url: url schema: $ref: '#/components/schemas/WebhookUpdateRequest' description: WebhookUpdateRequest object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebhookResponse' description: Updated webhook. '400': content: application/json: examples: webhook_not_found: $ref: '#/components/examples/webhook_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: >- Webhook was not found. The supplied id does not match any webhook accessible to the calling client. '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' reward_supplier_not_found: $ref: '#/components/examples/reward_supplier_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests components: schemas: WebhookUpdateRequest: description: Body of a `PUT /v6/webhooks/{webhook_id}` request. properties: client_key_id: $ref: '#/components/schemas/ClientKeyIdInWebhookUpdateRequest' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array default_method: $ref: '#/components/schemas/DefaultMethodInWebhookUpdateRequest' description: $ref: '#/components/schemas/DescriptionInWebhookUpdateRequest' enabled: $ref: '#/components/schemas/EnabledInWebhookUpdateRequest' name: $ref: '#/components/schemas/NameInWebhookUpdateRequest' request: $ref: '#/components/schemas/RequestInWebhookUpdateRequest' response_body_handler: $ref: '#/components/schemas/ResponseBodyHandlerInWebhookUpdateRequest' response_handler: $ref: '#/components/schemas/ResponseHandlerInWebhookUpdateRequest' tags: items: type: string type: array uniqueItems: true url: $ref: '#/components/schemas/UrlInWebhookUpdateRequest' type: object WebhookResponse: discriminator: mapping: CLIENT: $ref: '#/components/schemas/ClientWebhookResponse' GENERIC: $ref: '#/components/schemas/GenericWebhookResponse' PARTNER: $ref: '#/components/schemas/PartnerWebhookResponse' REWARD: $ref: '#/components/schemas/RewardWebhookResponse' propertyName: type oneOf: - title: CLIENT allOf: - $ref: '#/components/schemas/ClientWebhookResponse' - title: GENERIC allOf: - $ref: '#/components/schemas/GenericWebhookResponse' - title: PARTNER allOf: - $ref: '#/components/schemas/PartnerWebhookResponse' - title: REWARD allOf: - $ref: '#/components/schemas/RewardWebhookResponse' required: - client_key_id - component_ids - component_references - created_at - default_method - description - enabled - id - name - request - response_handler - retry_intervals - tags - type - updated_at - url RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object ClientKeyIdInWebhookUpdateRequest: description: Choose between static or dynamic client key id oneOf: - description: Static client key id nullable: true title: Static Value type: object - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{clientKeyId}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('clientKeyId');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ComponentReferenceRequest: properties: component_id: type: string socket_names: items: type: string type: array type: object DefaultMethodInWebhookUpdateRequest: description: Choose between static or dynamic default method oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static default method title: Static Value - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{defaultMethod}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('defaultMethod');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInWebhookUpdateRequest: description: Choose between static or dynamic description oneOf: - description: Static description nullable: true title: Static Value type: string - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInWebhookUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled title: Static Value type: boolean - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string NameInWebhookUpdateRequest: description: Choose between static or dynamic name oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static name title: Static Value - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{name}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('name');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RequestInWebhookUpdateRequest: description: Choose between static or dynamic request oneOf: - allOf: - $ref: '#/components/schemas/WebhookRequest' description: Static request title: Static Value - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{request}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('request');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts). example: handlebars@runtime:{{request}} externalDocs: description: WebhookRuntimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts). example: javascript@runtime:function() { return context.get('request');} externalDocs: description: WebhookRuntimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ResponseBodyHandlerInWebhookUpdateRequest: description: Choose between static or dynamic response body handler oneOf: - additionalProperties: type: object description: Static response body handler title: Static Value type: object - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{responseBodyHandler}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('responseBodyHandler');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts). example: handlebars@runtime:{{responseBodyHandler}} externalDocs: description: WebhookResponseContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts). example: >- javascript@runtime:function() { return context.get('responseBodyHandler');} externalDocs: description: WebhookResponseContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ResponseHandlerInWebhookUpdateRequest: description: >- if no webhook response status is provided, we will retry non 2xx webhook requests oneOf: - description: Static response handler nullable: true title: Static Value type: string - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{responseHandler}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('responseHandler');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts). example: handlebars@runtime:{{responseHandler}} externalDocs: description: WebhookResponseContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts). example: >- javascript@runtime:function() { return context.get('responseHandler');} externalDocs: description: WebhookResponseContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string UrlInWebhookUpdateRequest: description: Choose between static or dynamic url oneOf: - description: Static url title: Static Value type: string - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{url}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('url');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ClientWebhookResponse: allOf: - $ref: '#/components/schemas/WebhookResponseBase' - properties: id: readOnly: true type: string type: enum: - CLIENT type: string type: object description: >- 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. required: - client_key_id - component_ids - component_references - created_at - default_method - description - enabled - id - name - request - response_handler - retry_intervals - tags - type - updated_at - url type: object title: CLIENT GenericWebhookResponse: allOf: - $ref: '#/components/schemas/WebhookResponseBase' - properties: id: readOnly: true type: string type: enum: - GENERIC type: string type: object description: >- 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. required: - client_key_id - component_ids - component_references - created_at - default_method - description - enabled - id - name - request - response_handler - retry_intervals - tags - type - updated_at - url type: object title: GENERIC PartnerWebhookResponse: allOf: - $ref: '#/components/schemas/WebhookResponseBase' - properties: id: readOnly: true type: string response_body_handler: $ref: '#/components/schemas/ResponseBodyHandlerInPartnerWebhookResponse' type: enum: - PARTNER type: string type: object description: >- 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. required: - client_key_id - component_ids - component_references - created_at - default_method - description - enabled - id - name - request - response_body_handler - response_handler - retry_intervals - tags - type - updated_at - url type: object title: PARTNER RewardWebhookResponse: allOf: - $ref: '#/components/schemas/WebhookResponseBase' - properties: filters: items: $ref: '#/components/schemas/RewardWebhookFilterResponse' type: array id: readOnly: true type: string type: enum: - REWARD type: string type: object description: >- 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. required: - client_key_id - component_ids - component_references - created_at - default_method - description - enabled - filters - id - name - request - response_handler - retry_intervals - tags - type - updated_at - url type: object title: REWARD WebhookRequest: properties: body: nullable: true type: string headers: additionalProperties: items: type: string type: array type: object method: type: string url: type: string urlTemplateParameters: additionalProperties: type: string type: object required: - body - headers - method - url - urlTemplateParameters type: object WebhookResponseBase: properties: client_key_id: $ref: '#/components/schemas/ClientKeyIdInWebhookResponseBase' component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array created_at: $ref: '#/components/schemas/ZonedDateTime' default_method: $ref: '#/components/schemas/DefaultMethodInWebhookResponseBase' description: $ref: '#/components/schemas/DescriptionInWebhookResponseBase' enabled: $ref: '#/components/schemas/EnabledInWebhookResponseBase' id: readOnly: true type: string name: $ref: '#/components/schemas/NameInWebhookResponseBase' request: $ref: '#/components/schemas/RequestInWebhookResponseBase' response_handler: $ref: '#/components/schemas/ResponseHandlerInWebhookResponseBase' retry_intervals: $ref: '#/components/schemas/RetryIntervalsInWebhookResponseBase' tags: items: type: string type: array uniqueItems: true type: enum: - CLIENT - GENERIC - PARTNER - REWARD type: string updated_at: $ref: '#/components/schemas/ZonedDateTime' url: $ref: '#/components/schemas/UrlInWebhookResponseBase' type: object ResponseBodyHandlerInPartnerWebhookResponse: description: >- The response body handler as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - additionalProperties: type: object description: Literal response body handler title: Static Value type: object - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{responseBodyHandler}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('responseBodyHandler');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts). example: handlebars@runtime:{{responseBodyHandler}} externalDocs: description: WebhookResponseContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts). example: >- javascript@runtime:function() { return context.get('responseBodyHandler');} externalDocs: description: WebhookResponseContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string RewardWebhookFilterResponse: properties: created_at: $ref: '#/components/schemas/ZonedDateTime' id: readOnly: true type: string type: enum: - EXPRESSION - STATE - SUPPLIER - TAGS type: string updated_at: $ref: '#/components/schemas/ZonedDateTime' required: - created_at - id - type - updated_at type: object ClientKeyIdInWebhookResponseBase: description: >- The client key id as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal client key id title: Static Value type: string - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{clientKeyId}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('clientKeyId');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ComponentReferenceResponse: properties: component_id: type: string socket_names: items: type: string type: array type: object ZonedDateTime: description: >- [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. example: '2025-10-24T02:00:00-07:00' pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$ type: string DefaultMethodInWebhookResponseBase: description: >- The default method as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal default method title: Static Value - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{defaultMethod}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('defaultMethod');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInWebhookResponseBase: description: >- The description as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal description title: Static Value type: string - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInWebhookResponseBase: description: >- The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal enabled title: Static Value type: boolean - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string NameInWebhookResponseBase: description: >- The name as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal name title: Static Value - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{name}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('name');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RequestInWebhookResponseBase: description: >- The request as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - $ref: '#/components/schemas/WebhookRequest' description: Literal request title: Static Value - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{request}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('request');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts). example: handlebars@runtime:{{request}} externalDocs: description: WebhookRuntimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [WebhookRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts). example: javascript@runtime:function() { return context.get('request');} externalDocs: description: WebhookRuntimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/WebhookRuntimeContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ResponseHandlerInWebhookResponseBase: description: >- if no webhook response status is provided, we will retry non 2xx webhook requests oneOf: - description: Literal response handler title: Static Value type: string - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{responseHandler}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('responseHandler');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: >- Handlebars expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts). example: handlebars@runtime:{{responseHandler}} externalDocs: description: WebhookResponseContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [WebhookResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts). example: >- javascript@runtime:function() { return context.get('responseHandler');} externalDocs: description: WebhookResponseContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/response/WebhookResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string RetryIntervalsInWebhookResponseBase: description: >- The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal retry intervals items: $ref: '#/components/schemas/Duration' title: Static Value type: array - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{retryIntervals}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('retryIntervals');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string UrlInWebhookResponseBase: description: >- The url as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal url title: Static Value type: string - description: >- Handlebars expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: handlebars@buildtime:{{url}} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [WebhookBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('url');} externalDocs: description: WebhookBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/webhook/built/WebhookBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string Duration: description: >- [RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.6) duration string. example: PT42S pattern: >- ^[-+]?P(?:(?:[-+]?[0-9]+D)(?:T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)?|T(?=(?:[-+]?[0-9]+H|[-+]?[0-9]+M|[-+]?[0-9]+(?:[.,][0-9]*)?S))(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]*)?S)?)$ type: string examples: webhook_not_found: summary: webhook_not_found value: code: webhook_not_found http_status_code: 400 message: Was unable to find webhook with id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 reward_supplier_not_found: summary: reward_supplier_not_found value: code: reward_supplier_not_found http_status_code: 403 message: Reward supplier not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ````