Extole Webhooks API
The Webhooks API from Extole — 4 operation(s) for webhooks.
Extole Webhooks API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 7 operations across 4 paths, and defines 53 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://{brand}.extole.io.
7 operations
4 paths
53 schemas
1 DELETE4 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Extole Webhooks API declares
3 security schemes
for authenticating requests.
An API key is passed in the cookie as extole_token (COOKIE).
An API key is passed in the header as Authorization (HEADER).
An API key is passed in the query as access_token (QUERY).
By default, every request must be authenticated.
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Webhooks 7
GET
/v6/webhooks
List webhooks
POST
/v6/webhooks
Create a webhook
GET
/v6/webhooks/built
List built webhooks
GET
/v6/webhooks/{webhook_id}
Get a webhook
PUT
/v6/webhooks/{webhook_id}
Update a webhook
DELETE
/v6/webhooks/{webhook_id}
Archive a webhook
GET
/v6/webhooks/{webhook_id}/built
Get a built webhook
Schemas 53
The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are WebhookResponseBase (16 properties), BuiltWebhookResponseBase (16 properties), WebhookCreateRequest (14 properties), WebhookUpdateRequest (12 properties). Each schema is shown below with its type and property counts.
RewardWebhookResponse
object
Stored reward webhook definition. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals are unevalua…
17 required
RequestInWebhookResponseBase
The request as configured: a literal value, or an expression (type:string) when defined dynamically.
WebhookResponse
16 required
RequestInBuiltWebhookResponseBase
The request as configured: a literal value, or an expression (type:string) when defined dynamically.
RetryIntervalsInWebhookResponseBase
The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltClientWebhookResponse
object
client webhook after buildtime evaluation. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals are…
16 required
UrlInWebhookCreateRequest
Choose between static or dynamic url
WebhookUpdateRequest
object
Body of a PUT /v6/webhooks/{webhookid} request.
12 properties
WebhookCreateRequest
object
Body of a POST /v6/webhooks request.
14 properties
2 required
WebhookRequest
object
5 properties
5 required
NameInWebhookResponseBase
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltRewardWebhookResponse
object
reward webhook after buildtime evaluation. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals are…
17 required
GenericWebhookResponse
object
Stored generic webhook definition. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals are unevalu…
16 required
EnabledInWebhookCreateRequest
Choose between static or dynamic enabled
WebhookResponseBase
object
16 properties
ResponseBodyHandlerInWebhookUpdateRequest
Choose between static or dynamic response body handler
EnabledInWebhookUpdateRequest
Choose between static or dynamic enabled
ClientKeyIdInWebhookUpdateRequest
Choose between static or dynamic client key id
RequestInWebhookCreateRequest
Choose between static or dynamic request
DescriptionInWebhookUpdateRequest
Choose between static or dynamic description
Duration
string
[RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545section-3.3.6) duration string.
DescriptionInWebhookResponseBase
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
ClientKeyIdInWebhookResponseBase
The client key id as configured: a literal value, or an expression (type:string) when defined dynamically.
ResponseBodyHandlerInBuiltPartnerWebhookResponse
The response body handler as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltPartnerWebhookResponse
object
partner webhook after buildtime evaluation. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, retryintervals, and r…
17 required
ResponseHandlerInWebhookCreateRequest
if no webhook response status is provided, we will retry non 2xx webhook requests
UrlInWebhookUpdateRequest
Choose between static or dynamic url
ClientKeyIdInWebhookCreateRequest
Choose between static or dynamic client key id
ResponseHandlerInWebhookUpdateRequest
if no webhook response status is provided, we will retry non 2xx webhook requests
BuiltGenericWebhookResponse
object
generic webhook after buildtime evaluation. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals ar…
16 required
DefaultMethodInWebhookUpdateRequest
Choose between static or dynamic default method
ClientWebhookResponse
object
Stored client webhook definition. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals are unevalua…
16 required
ResponseBodyHandlerInPartnerWebhookResponse
The response body handler as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInWebhookResponseBase
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
RestExceptionResponse
object
Represents the API error response
5 properties
5 required
ComponentReferenceResponse
object
2 properties
RetryIntervalsInWebhookCreateRequest
Choose between static or dynamic retry intervals
ComponentReferenceRequest
object
2 properties
DefaultMethodInWebhookCreateRequest
Choose between static or dynamic default method
DefaultMethodInWebhookResponseBase
The default method as configured: a literal value, or an expression (type:string) when defined dynamically.
ResponseHandlerInWebhookResponseBase
if no webhook response status is provided, we will retry non 2xx webhook requests
PartnerWebhookResponse
object
Stored partner webhook definition. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, retryintervals, and responsebo…
17 required
DescriptionInWebhookCreateRequest
Choose between static or dynamic description
RequestInWebhookUpdateRequest
Choose between static or dynamic request
ResponseHandlerInBuiltWebhookResponseBase
if no webhook response status is provided, we will retry non 2xx webhook requests
UrlInWebhookResponseBase
The url as configured: a literal value, or an expression (type:string) when defined dynamically.
RewardWebhookFilterResponse
object
4 properties
4 required
BuiltWebhookResponseBase
object
16 properties
BuiltWebhookResponse
webhook after buildtime evaluation. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals are alread…
16 required
NameInWebhookUpdateRequest
Choose between static or dynamic name
ResponseBodyHandlerInWebhookCreateRequest
Choose between static or dynamic response body handler
NameInWebhookCreateRequest
Choose between static or dynamic name
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Extole 12
Other APIs Extole publishes across the network.
Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API
#Webhooks