Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
event_subscriptions
Event Subscriptions

List Event Subscriptions

List Event Subscriptions

get/event_subscriptions

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, event_channel_id or workspace_id.

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

Response

A list of EventSubscriptions objects.

idinteger

Event Subscription ID

event_channel_idinteger

Event Channel ID

workspace_idinteger

Workspace ID. 0 means the default workspace or site-wide.

apply_to_all_workspacesboolean

If true, this default-workspace subscription applies to events from all workspaces.

namestring

Event Subscription name.

enabledboolean

Whether this Event Subscription can dispatch events.

event_typesstring[]

Event type strings matched by this subscription. Blank means all event types.

filterobject

Structured event payload filter.

delivery_policyobject

Event Subscription delivery policy.

event_target_idsinteger[]

Event Target IDs this subscription sends to.

created_atstring date-time

Event Subscription create date/time.

updated_atstring date-time

Event Subscription update date/time.

Example response

[
  {
    "id": 1,
    "event_channel_id": 1,
    "workspace_id": 1,
    "apply_to_all_workspaces": true,
    "name": "example",
    "enabled": true,
    "event_types": [
      "example"
    ],
    "event_target_ids": [
      1
    ],
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z"
  }
]