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 Streams API

The Event Streams API from Extole — 9 operation(s) for event streams.

Extole Event Streams 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 Streams. The published artifact set on APIs.io includes an OpenAPI specification.

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

15 operations 9 paths 36 schemas 2 DELETE7 GET4 POST2 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 Streams 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 15

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

Event Streams 15
GET
/v6/event-streams
List event streams
listEventStreams 3 params → 200400401402403415429
POST
/v6/event-streams
Create an event stream
createEventStream body → 200400401402403415429
GET
/v6/event-streams/built
List built event streams
listBuiltEventStreams 3 params → 200400401402403415429
GET
/v6/event-streams/{eventStreamId}
Get an event stream
getEventStream 1 param → 200400401402403415429
PUT
/v6/event-streams/{eventStreamId}
Update an event stream
updateEventStream 1 param body → 200400401402403415429
DELETE
/v6/event-streams/{eventStreamId}
Archive an event stream
archiveEventStream 1 param → 200400401402403415429
GET
/v6/event-streams/{eventStreamId}/built
Get a built event stream
getBuiltEventStream 1 param → 200400401402403415429
GET
/v6/event-streams/{eventStreamId}/events
List events from an event stream
listEventStreamEvents 6 params → 200400401402403415429
GET
/v6/event-streams/{eventStreamId}/filters
List event stream filters
listEventStreamFilters 1 param → 200400401402403415429
POST
/v6/event-streams/{eventStreamId}/filters
Create an event stream filter
createEventStreamFilter 1 param body → 200400401402403415429
GET
/v6/event-streams/{eventStreamId}/filters/{filterId}
Get an event stream filter
getEventStreamFilter 2 params → 200400401402403415429
PUT
/v6/event-streams/{eventStreamId}/filters/{filterId}
Update an event stream filter
updateEventStreamFilter 2 params body → 200400401402403415429
DELETE
/v6/event-streams/{eventStreamId}/filters/{filterId}
Archive an event stream filter
archiveEventStreamFilter 2 params → 200400401402403415429
POST
/v6/event-streams/{eventStreamId}/delete
Delete an event stream
deleteEventStream 1 param → 200400401402403415429
POST
/v6/event-streams/{eventStreamId}/unarchive
Unarchive an event stream
unarchiveEventStream 1 param → 200400401402403415429

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are BuiltEventStreamResponse (9 properties), EventStreamResponse (9 properties), EventStreamCreateRequest (6 properties), EventStreamUpdateRequest (6 properties). Each schema is shown below with its type and property counts.

EventStreamPersonIdFilterUpdateRequest
object
1 required
EventStreamEventNameFilterUpdateRequest
object
1 required
EventStreamEventNameFilterResponse
object
3 required
EventStreamEventTypeFilterCreateRequest
object
1 required
NameInEventStreamResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
EventStreamUpdateRequest
object
Body of a PUT /v6/event-streams/{eventStreamId} request.
6 properties
EventStreamApplicationTypeFilterResponse
object
3 required
EventStreamFilterCreateRequestBase
object
1 property
EventStreamCreateRequest
object
Body of a POST /v6/event-streams request.
6 properties 1 required
EventStreamFilterResponseBase
object
2 properties
EventStreamFilterUpdateRequest
Body of a PUT /v6/event-streams/{eventStreamId}/filters/{filterId} request.
1 required
EventStreamEventNameFilterCreateRequest
object
1 required
EventStreamSandboxFilterUpdateRequest
object
1 required
DescriptionInEventStreamUpdateRequest
Choose between static or dynamic description
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…
EventStreamApplicationTypeFilterCreateRequest
object
1 required
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
NameInEventStreamCreateRequest
Choose between static or dynamic name
EventStreamPersonIdFilterCreateRequest
object
1 required
Instant
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) UTC date-time with a Z suffix. Precision up to milliseconds.
ComponentReferenceRequest
object
2 properties
EventStreamSandboxFilterResponse
object
4 required
EventStreamResponse
object
Stored event stream definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
9 properties 9 required
BuiltEventStreamResponse
object
event stream after buildtime evaluation. Fields name and description are already evaluated.
9 properties 9 required
DescriptionInEventStreamCreateRequest
Choose between static or dynamic description
EventStreamFilterResponse
2 required
NameInEventStreamUpdateRequest
Choose between static or dynamic name
EventStreamFilterCreateRequest
Body of a POST /v6/event-streams/{eventStreamId}/filters request.
1 required
DescriptionInEventStreamResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
EventStreamFilterUpdateRequestBase
object
1 property
EventStreamSandboxFilterCreateRequest
object
1 required
EventStreamPersonIdFilterResponse
object
3 required
EventStreamEventTypeFilterResponse
object
3 required
EventStreamEventTypeFilterUpdateRequest
object
1 required
EventStreamApplicationTypeFilterUpdateRequest
object
1 required
EventStreamEventResponse
object
Event captured by an event stream, including identifiers, timestamp, and raw event payload.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-event-streams-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 Streams 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.