Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
event_channels
Event Channels

List Event Channels

List Event Channels

get/event_channels

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are name, enabled, default_channel or workspace_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are enabled, default_channel or workspace_id. Valid field combinations are [ workspace_id, enabled ] and [ workspace_id, default_channel ].

Response

A list of EventChannels objects.

idinteger

Event Channel ID

namestring

Event Channel name.

workspace_idinteger

Workspace ID. 0 means the default workspace.

descriptionstring

Event Channel description.

enabledboolean

Whether this Event Channel can dispatch events.

default_channelboolean

Whether this Event Channel is the default destination for newly published events.

created_atstring date-time

Event Channel create date/time.

updated_atstring date-time

Event Channel update date/time.

Example response

[
  {
    "id": 1,
    "name": "example",
    "workspace_id": 1,
    "description": "example",
    "enabled": true,
    "default_channel": true,
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z"
  }
]