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.0.1, at version 1.0.
Requests are made against a single base URL, https://{brand}.extole.io.
15 operations9 paths36 schemas2 DELETE7 GET4 POST2 PUT
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 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.
The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are EventStreamResponse (9 properties), BuiltEventStreamResponse (9 properties), EventStreamUpdateRequest (6 properties), EventStreamCreateRequest (6 properties). Each schema is shown below with its type and property counts.
EventStreamApplicationTypeFilterCreateRequest
object
1 required
EventStreamPersonIdFilterResponse
object
3 required
EventStreamFilterCreateRequest
Body of a POST /v6/event-streams/{eventStreamId}/filters request.
1 required
EventStreamFilterResponseBase
object
2 properties
DescriptionInEventStreamCreateRequest
Choose between static or dynamic description
EventStreamEventNameFilterResponse
object
3 required
EventStreamApplicationTypeFilterResponse
object
3 required
ComponentReferenceRequest
object
2 properties
EventStreamSandboxFilterResponse
object
4 required
NameInEventStreamCreateRequest
Choose between static or dynamic name
EventStreamEventNameFilterCreateRequest
object
1 required
EventStreamResponse
object
Stored event stream definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
9 properties9 required
NameInEventStreamResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
EventStreamSandboxFilterCreateRequest
object
1 required
EventStreamSandboxFilterUpdateRequest
object
1 required
EventStreamPersonIdFilterUpdateRequest
object
1 required
DescriptionInEventStreamUpdateRequest
Choose between static or dynamic description
EventStreamPersonIdFilterCreateRequest
object
1 required
DescriptionInEventStreamResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
EventStreamEventNameFilterUpdateRequest
object
1 required
EventStreamEventResponse
object
Event captured by an event stream, including identifiers, timestamp, and raw event payload.
4 properties4 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.
EventStreamEventTypeFilterResponse
object
3 required
EventStreamFilterUpdateRequestBase
object
1 property
EventStreamEventTypeFilterUpdateRequest
object
1 required
EventStreamFilterUpdateRequest
Body of a PUT /v6/event-streams/{eventStreamId}/filters/{filterId} request.
1 required
EventStreamCreateRequest
object
Body of a POST /v6/event-streams request.
6 properties1 required
EventStreamUpdateRequest
object
Body of a PUT /v6/event-streams/{eventStreamId} request.
6 properties
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…
EventStreamApplicationTypeFilterUpdateRequest
object
1 required
EventStreamFilterResponse
2 required
RestExceptionResponse
object
Represents the API error response
5 properties5 required
NameInEventStreamUpdateRequest
Choose between static or dynamic name
BuiltEventStreamResponse
object
event stream after buildtime evaluation. Fields name and description are already evaluated.
9 properties9 required
EventStreamFilterCreateRequestBase
object
1 property
EventStreamEventTypeFilterCreateRequest
object
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
