FIfiles
event_subscriptions
Event Subscriptions

List Event Subscriptions

Changed on

List Event Subscriptions

get/event_subscriptions

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/event_subscriptions
  • Auth
    none declared

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

subjectstring

Custom subject line to use for notification emails.

messagestring

Custom message to include in notification emails.

message_onlyboolean

If true, notification email bodies contain only the custom message, omitting event details and the review button. Requires a custom message, defaults to false, and does not affect non-email targets.

enabledboolean

Whether this Event Subscription can dispatch events.

event_typesstring[]

Event type strings matched by this subscription. Blank means all event types. Valid values: automation_run.canceled.v1, automation_run.failure.v1, automation_run.failure_will_retry.v1, automation_run.partial_failure.v1, automation_run.partial_failure_will_retry.v1, automation_run.skipped.v1, automation_run.success.v1, expectation_evaluation.invalid.v1, expectation_evaluation.late.v1, expectation_evaluation.missing.v1, expectation_evaluation.success.v1, expectation_incident.acknowledged.v1, expectation_incident.open.v1, expectation_incident.resolved.v1, expectation_incident.snoozed.v1, external_event.client_log.failure.v1, external_event.client_log.partial_failure.v1, external_event.client_log.skipped.v1, external_event.client_log.success.v1, malware_scan_log.quarantined.v1, pending_work_event.failure.v1, pending_work_event.partial_failure.v1, pending_work_event.skipped.v1, pending_work_event.success.v1, siem_http_destination_event.failure.v1, siem_http_destination_event.partial_failure.v1, siem_http_destination_event.skipped.v1, siem_http_destination_event.success.v1, sso_event.ldap_login.failure.v1, sso_event.ldap_login.partial_failure.v1, sso_event.ldap_login.skipped.v1, sso_event.ldap_login.success.v1, sso_event.ldap_sync.failure.v1, sso_event.ldap_sync.partial_failure.v1, sso_event.ldap_sync.skipped.v1, sso_event.ldap_sync.success.v1, sso_event.saml_login.failure.v1, sso_event.saml_login.partial_failure.v1, sso_event.saml_login.skipped.v1, sso_event.saml_login.success.v1, sync_run.failure.v1, sync_run.partial_failure.v1, sync_run.skipped.v1, sync_run.success.v1, user_security_event.lockout.v1

filterobject

Conditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.

delivery_policyobject

Event Subscription delivery policy. Overrides retry settings from each Event Target's 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",
    "message_only": true,
    "enabled": true,
    "event_types": [
      "sync_run.failure.v1"
    ],
    "filter": {
      "payload.sync_name": {
        "prefix": "Nightly"
      },
      "payload.event_errors": {
        "exists": true
      }
    },
    "event_target_ids": [
      1
    ],
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z"
  }
]

Changes