<< All versions

Skill v1.0.2

currentAutomated scan100/100
files-com/files-cli/filescom-event-subscriptions

~1 modified

──Details
PublishedOctober 27, 2026 at 03:48 AM
Content Hashsha256:930dd10e362d5004...
Git SHA229869bba332
Bump Typepatch
Compare with v1.0.1
──Files
Files (1 file, 7.3 KB)
SKILL.md7.3 KBactive
SKILL.md · 80 lines · 7.3 KB

version: "1.0.2" name: filescom-event-subscriptions description: | An EventSubscription selects EventRecords for an EventChannel and sends them to one or more EventTargets.


filescom-event-subscriptions

An EventSubscription selects EventRecords for an EventChannel and sends them to one or more EventTargets.

All subcommands also accept the flags documented in `CONTEXT.md` (--api-key, --format, --workspace-id, --debug, and the pagination flags --cursor / --per-page / --max-pages on list). Those are not repeated below.

Commands

files-cli event-subscriptions list

List Event Subscriptions.

FlagTypeDescription
--sort-byobjectIf set, sort records by the specified field in either asc or desc direction. Valid fields are name, enabled, event_channel_id or workspace_id.
--filterobjectIf 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 ].

files-cli event-subscriptions find

Show Event Subscription.

FlagTypeDescription
--idint64Event Subscription ID. Required.

files-cli event-subscriptions create

Create Event Subscription.

FlagTypeDescription
--event-channel-idint64Event Channel ID
--workspace-idint64Workspace ID. 0 means the default workspace or site-wide.
--apply-to-all-workspacesboolIf true, this default-workspace subscription applies to events from all workspaces.
--namestringEvent Subscription name. Required.
--subjectstringCustom subject line to use for notification emails.
--messagestringCustom message to include in notification emails.
--message-onlyboolIf 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.
--enabledboolWhether this Event Subscription can dispatch events.
--event-types[]stringEvent 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, 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
--filterobjectConditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
--delivery-policyobjectEvent Subscription delivery policy.
--event-target-ids[]int64Event Target IDs this subscription sends to.

files-cli event-subscriptions update

Update Event Subscription.

FlagTypeDescription
--idint64Event Subscription ID. Required.
--event-channel-idint64Event Channel ID
--workspace-idint64Workspace ID. 0 means the default workspace or site-wide.
--apply-to-all-workspacesboolIf true, this default-workspace subscription applies to events from all workspaces.
--namestringEvent Subscription name.
--subjectstringCustom subject line to use for notification emails.
--messagestringCustom message to include in notification emails.
--message-onlyboolIf 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.
--enabledboolWhether this Event Subscription can dispatch events.
--event-types[]stringEvent 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, 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
--filterobjectConditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
--delivery-policyobjectEvent Subscription delivery policy.
--event-target-ids[]int64Event Target IDs this subscription sends to.

files-cli event-subscriptions delete

Delete Event Subscription.

FlagTypeDescription
--idint64Event Subscription ID. Required.
← v1.0.1All versions