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 Event Prehandlers API

The Event Prehandlers API from Extole — 6 operation(s) for event prehandlers.

Extole Event Prehandlers API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Event Prehandlers. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 6 paths, and defines 60 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.

9 operations 6 paths 60 schemas 1 DELETE4 GET3 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 Event Prehandlers 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 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Event Prehandlers 9
GET
/v6/prehandlers
List prehandlers
listPrehandlers 4 params → 200400401402403415429
POST
/v6/prehandlers
Create a prehandler
createPrehandler body → 200400401402403415429
GET
/v6/prehandlers/built
List built prehandlers
listBuiltPrehandlers 4 params → 200400401402403415429
GET
/v6/prehandlers/{prehandlerId}
Get a prehandler
getPrehandler 1 param → 200400401402403415429
PUT
/v6/prehandlers/{prehandlerId}
Update a prehandler
updatePrehandler 1 param body → 200400401402403415429
DELETE
/v6/prehandlers/{prehandlerId}
Delete a prehandler
deletePrehandler 1 param → 200400401402403415429
GET
/v6/prehandlers/{prehandlerId}/built
Get a built prehandler
getBuiltPrehandler 1 param → 200400401402403415429
POST
/v6/prehandlers/{prehandlerId}/archive
Archive a prehandler
archivePrehandler 1 param → 200400401402403415429
POST
/v6/prehandlers/{prehandlerId}/unarchive
Unarchive a prehandler
unarchivePrehandler 1 param → 200400401402403415429

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are PrehandlerResponse (12 properties), BuiltPrehandlerResponse (12 properties), PrehandlerCreateRequest (9 properties), PrehandlerUpdateRequest (9 properties). Each schema is shown below with its type and property counts.

DataMapInSetDataPrehandlerActionRequest
objectnull
Data to be set to the event. Data names (keys) are not case sensitive.
PrehandlerActionResponseBase
object
2 properties
NameInPrehandlerUpdateRequest
Prehandler name must be unique.
BlockMatchPrehandlerConditionRequest
object
Condition that adds the block list types to be checked.
1 required
EnabledInPrehandlerCreateRequest
Choose between static or dynamic enabled
BuiltPrehandlerResponse
object
Built prehandler with evaluated runtime values used by the event-processing pipeline.
12 properties 12 required
HttpHeaderMatchPrehandlerConditionRequest
object
Condition that checks the event HTTP headers.
3 required
JavascriptPrehandlerConditionRequest
object
Condition represented by Javascript. It evaluates to true if the javascript returns true.
2 required
DataExistsPrehandlerConditionRequest
object
Condition that checks the data name exists.
2 required
EventNameMatchPrehandlerConditionResponse
object
Condition that checks the event name.
3 required
BlockMatchPrehandlerConditionResponse
object
Condition that adds the block list types to be checked.
3 required
DataAttributeMapping
object
3 properties
MapDataAttributesPrehandlerActionRequest
object
Action that modifies the event data based on data mappers attributes.
2 required
PrehandlerActionRequest
1 required
JavascriptPrehandlerActionRequest
object
Action represented by Javascript that can change the event.
2 required
ExpressionInExpressionPrehandlerConditionResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
ExpressionPrehandlerActionRequest
object
Action represented by expression that can change the event.
2 required
OrderInPrehandlerResponse
Build-time expression that controls the prehandler execution order.
ComponentReferenceResponse
object
2 properties
PrehandlerResponse
object
Prehandler source definition with build-time fields, conditions, actions, and execution order.
12 properties 12 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…
DescriptionInPrehandlerUpdateRequest
Choose between static or dynamic description
ComponentReferenceRequest
object
2 properties
ExpressionPrehandlerConditionResponse
object
Condition represented by expression. It evaluates to true if the expression returns true.
3 required
PrehandlerActionRequestBase
object
1 property
Default_dataMapInSetDataPrehandlerActionRequest
objectnull
Default data to be set to the event. Only data (keys) that are not already present in the event will be set. Data names (keys) are not case sensitive.
PrehandlerActionResponse
Actions executed when the prehandler conditions match.
DefaultValueInDataAttributeMapping
Choose between static or dynamic default value
SetSandboxPrehandlerActionRequest
object
Action that modifies the event sandbox.
2 required
PrehandlerConditionResponseBase
object
2 properties
NameInPrehandlerResponse
Build-time expression that resolves to the prehandler name.
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
ExpressionInExpressionPrehandlerActionResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
PrehandlerConditionResponse
Conditions that must match before the prehandler actions run.
OrderInPrehandlerCreateRequest
Choose between static or dynamic order
EnabledInPrehandlerUpdateRequest
Choose between static or dynamic enabled
DataExistsPrehandlerConditionResponse
object
Condition that checks the data name exists.
3 required
PrehandlerCreateRequest
object
Body of a POST /v6/prehandlers request.
9 properties 1 required
PrehandlerUpdateRequest
object
Body of a PUT /v6/prehandlers/{prehandlerId} request.
9 properties
OrderInPrehandlerUpdateRequest
Choose between static or dynamic order
ExpressionInExpressionPrehandlerActionRequest
Choose between static or dynamic expression
SetDataPrehandlerActionRequest
object
Action that modifies the event data.
4 required
PrehandlerConditionRequest
1 required
ExpressionInExpressionPrehandlerConditionRequest
Choose between static or dynamic expression
JavascriptPrehandlerConditionResponse
object
Condition represented by Javascript. It evaluates to true if the javascript returns true.
3 required
DataInSetDataPrehandlerActionRequest
Data to be set to the event. Data names (keys) are not case sensitive.
ExpressionPrehandlerActionResponse
object
Action represented by expression that can change the event.
3 required
HttpHeaderMatchPrehandlerConditionResponse
object
Condition that checks the event HTTP headers.
4 required
DefaultDataInSetDataPrehandlerActionRequest
Default data to be set to the event. Only data (keys) that are not already present in the event will be set. Data names (keys) are not case sensitive.
ExpressionPrehandlerConditionRequest
object
Condition represented by expression. It evaluates to true if the expression returns true.
2 required
EnabledInPrehandlerResponse
Build-time expression that controls whether the prehandler is active.
MapDataAttributesPrehandlerActionResponse
object
Action represented by data mappers that can change the data of the event.
3 required
EventNameMatchPrehandlerConditionRequest
object
Condition that checks the event name.
2 required
PrehandlerConditionRequestBase
object
1 property
NameInPrehandlerCreateRequest
Prehandler name must be unique.
JavascriptPrehandlerActionResponse
object
Action represented by Javascript that can change the event.
3 required
SetDataPrehandlerActionResponse
object
Action that modifies the event data.
5 required
DescriptionInPrehandlerResponse
Optional build-time expression that resolves to the prehandler description.
DescriptionInPrehandlerCreateRequest
Choose between static or dynamic description
SetSandboxPrehandlerActionResponse
object
Action that modifies the event sandbox.
3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-event-prehandlers-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 Event Prehandlers 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.