Sign in
event_subscriptions
Event Subscriptions

Create Event Subscription

Create Event Subscription

post/event_subscriptions

Response

The EventSubscriptions object.

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.

subjectstring

Custom subject line to use for notification emails.

messagestring

Custom message to include in notification emails.

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",
  "subject": "example",
  "message": "example",
  "enabled": true,
  "event_types": [
    "example"
  ],
  "event_target_ids": [
    1
  ],
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}

Changes