v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Event Orchestrations

List Event Orchestrations

List all Global Event Orchestrations on an Account.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.read

get/event_orchestrations

Query parameters

limitinteger

The number of results per page.

offsetinteger

Offset to start pagination search results.

sort_by'name:asc' | 'name:desc' | 'routes:asc' | 'routes:desc' | 'created_at:asc' | 'created_at:desc'

Used to specify the field you wish to sort the results on.

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Response

A paginated array of Event Orchestration objects.

offsetinteger

Echoes offset pagination property.

limitinteger

Echoes limit pagination property.

moreboolean

Indicates if there are additional records to return

totalinteger nullable

The total number of records matching the given query.