v4

latestSwagger 2.02026-08-0343714211.7 MB

event_targets

Event Targets

List Event Targets

get/event_targets

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

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

Response

A list of EventTargets objects.

idinteger

Event Target ID

namestring

Event Target name.

Event Target type.

workspace_idinteger

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

apply_to_all_workspacesboolean

If true, this default-workspace target can receive events from all workspaces.

enabledboolean

Whether this Event Target can receive events.

configobject

Event Target configuration. Folder targets accept path and format (json or csv).

delivery_policyobject

Event Target delivery policy. Email and folder targets support batch_interval in seconds, between 600 and 86400.

created_atstring date-time

Event Target create date/time.

updated_atstring date-time

Event Target update date/time.

Example response

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