Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extole Events API

The Events API from Extole — 6 operation(s) for events.

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

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

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

6 operations 6 paths 11 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 3

Extole Events 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 6

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

Events 6
GET
/events/{event_name}
Submit a consumer event by URL
fetchConsumerEventByName 1 param → 200400401403415429
POST
/v6/async-events
Submit an event asynchronously
submitEventAsync body → 200400401402403415429
POST
/v6/async-events/{event_name}
Submit a named event asynchronously
submitNamedEventAsync 1 param body → 200400401402403415429
POST
/v6/events
Submit an event
submitEvent body → 200400401402403415429
POST
/v6/events/{event_name}
Submit a named event
submitNamedEvent 1 param body → 200400401402403415429
GET
/v3/signals/step/status/{pollingId}
getStatus_2 1 param → 200400401403415429

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are StepSignal (6 properties), RestExceptionResponse (5 properties), EventSubmissionData (4 properties), SubmitEventResponse (3 properties). Each schema is shown below with its type and property counts.

QualityRuleResult
object
2 properties
StepSignalResponse
object
2 properties 2 required
SubmitEventResponse
object
3 properties 3 required
PartnerEventIdResponse
object
2 properties
EventDispatcherRequest
object
3 properties 3 required
EventDispatcherAsyncResponse
object
1 property 1 required
QualityResults
object
2 properties
StepSignal
object
6 properties
EventSubmissionData
object
Open map of fields submitted with an event. May include keys beyond those listed here. email is the primary identity key and the only field that enables profil…
4 properties
EventDispatcherResponse
object
2 properties 2 required
RestExceptionResponse
object
Represents the API error response
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-events-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