How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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 Webhook. 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.2.0, 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.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

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
listWebhooks 2 params → 200400401402403415429
POST
/v6/webhooks
Create a webhook
createWebhook body → 200400401402403415429
GET
/v6/webhooks/built
List built webhooks
listBuiltWebhooks 6 params → 200400401402403415429
GET
/v6/webhooks/{webhook_id}
Get a webhook
getWebhook 1 param → 200400401402403415429
PUT
/v6/webhooks/{webhook_id}
Update a webhook
updateWebhook 1 param body → 200400401402403415429
DELETE
/v6/webhooks/{webhook_id}
Archive a webhook
archiveWebhook 1 param → 200400401402403415429
GET
/v6/webhooks/{webhook_id}/built
Get a built webhook
getBuiltWebhook 1 param → 200400401402403415429

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are BuiltWebhookResponseBase (16 properties), WebhookResponseBase (16 properties), WebhookCreateRequest (14 properties), WebhookUpdateRequest (12 properties). Each schema is shown below with its type and property counts.

BuiltWebhookResponseBase
object
16 properties
WebhookRequest
object
5 properties 5 required
EnabledInWebhookResponseBase
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
ResponseBodyHandlerInWebhookCreateRequest
Choose between static or dynamic response body handler
ResponseBodyHandlerInWebhookUpdateRequest
Choose between static or dynamic response body handler
ResponseHandlerInWebhookUpdateRequest
if no webhook response status is provided, we will retry non 2xx webhook requests
NameInWebhookUpdateRequest
Choose between static or dynamic name
RewardWebhookFilterResponse
object
4 properties 4 required
WebhookResponseBase
object
16 properties
ComponentReferenceResponse
object
2 properties
NameInWebhookResponseBase
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
RequestInWebhookCreateRequest
Choose between static or dynamic request
WebhookUpdateRequest
object
Body of a PUT /v6/webhooks/{webhookid} request.
12 properties
DefaultMethodInWebhookCreateRequest
Choose between static or dynamic default method
DescriptionInWebhookUpdateRequest
Choose between static or dynamic description
WebhookResponse
16 required
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…
ComponentReferenceRequest
object
2 properties
UrlInWebhookCreateRequest
Choose between static or dynamic url
Duration
string
[RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545section-3.3.6) duration string.
ResponseHandlerInWebhookResponseBase
if no webhook response status is provided, we will retry non 2xx webhook requests
ClientWebhookResponse
object
Stored client webhook definition. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals are unevalua…
16 required
ClientKeyIdInWebhookResponseBase
The client key id as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInWebhookCreateRequest
Choose between static or dynamic description
UrlInWebhookUpdateRequest
Choose between static or dynamic url
BuiltPartnerWebhookResponse
object
partner webhook after buildtime evaluation. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, retryintervals, and r…
17 required
GenericWebhookResponse
object
Stored generic webhook definition. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals are unevalu…
16 required
ResponseHandlerInWebhookCreateRequest
if no webhook response status is provided, we will retry non 2xx webhook requests
EnabledInWebhookCreateRequest
Choose between static or dynamic enabled
ResponseBodyHandlerInPartnerWebhookResponse
The response body handler as configured: a literal value, or an expression (type:string) when defined dynamically.
ClientKeyIdInWebhookCreateRequest
Choose between static or dynamic client key id
EnabledInWebhookUpdateRequest
Choose between static or dynamic enabled
BuiltClientWebhookResponse
object
client webhook after buildtime evaluation. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals are…
16 required
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
DescriptionInWebhookResponseBase
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
RequestInWebhookUpdateRequest
Choose between static or dynamic request
RetryIntervalsInWebhookCreateRequest
Choose between static or dynamic retry intervals
DefaultMethodInWebhookUpdateRequest
Choose between static or dynamic default method
PartnerWebhookResponse
object
Stored partner webhook definition. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, retryintervals, and responsebo…
17 required
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.
ClientKeyIdInWebhookUpdateRequest
Choose between static or dynamic client key id
BuiltWebhookResponse
webhook after buildtime evaluation. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals are alread…
16 required
RetryIntervalsInWebhookResponseBase
The retry intervals as configured: a literal value, or an expression (type:string) when defined dynamically.
DefaultMethodInWebhookResponseBase
The default method as configured: a literal value, or an expression (type:string) when defined dynamically.
RequestInBuiltWebhookResponseBase
The request as configured: a literal value, or an expression (type:string) when defined dynamically.
WebhookCreateRequest
object
Body of a POST /v6/webhooks request.
14 properties 2 required
ResponseBodyHandlerInBuiltPartnerWebhookResponse
The response body handler as configured: a literal value, or an expression (type:string) when defined dynamically.
NameInWebhookCreateRequest
Choose between static or dynamic name
BuiltGenericWebhookResponse
object
generic webhook after buildtime evaluation. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals ar…
16 required
BuiltRewardWebhookResponse
object
reward webhook after buildtime evaluation. Fields name, url, clientkeyid, request, responsehandler, enabled, description, defaultmethod, and retryintervals are…
17 required
UrlInWebhookResponseBase
The url as configured: a literal value, or an expression (type:string) when defined dynamically.
ResponseHandlerInBuiltWebhookResponseBase
if no webhook response status is provided, we will retry non 2xx webhook requests

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-webhooks-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Extole Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.