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