Event Targets
An EventTarget is a delivery destination for EventRecords.
List Event Targets
Command
files-cli event-targets list
Output
Outputs a list of EventTarget objects according to the output format.
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Additional Arguments
Show Event Target
Command
files-cli event-targets find
Output
Outputs a EventTarget object according to the output format.
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Flags
| Flag | Description |
|---|---|
| --id= int64 Required | Event Target ID. |
Create Event Target
Command
files-cli event-targets create
Output
Outputs a EventTarget object according to the output format.
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Flags
| Flag | Default | Description |
|---|---|---|
| --name= string Required | Event Target name. | |
| --workspace-id= int64 | 0 | Workspace ID. 0 means the default workspace or site-wide. |
| --apply-to-all-workspaces boolean | false | If true, this default-workspace target can receive events from all workspaces. |
| --enabled boolean | true | Whether this Event Target can receive events. |
| --config= object Required | Event Target configuration. Folder targets accept path and format (json or csv). | |
| --delivery-policy= object | Event Target delivery policy. Email and folder targets support batch_interval in seconds, between 600 and 86400. | |
| --target-type= string Required | Event Target type. Possible values: email, webhook, slack_webhook, teams_webhook, amazon_sns, google_pubsub, folder |
Update Event Target
Command
files-cli event-targets update
Output
Outputs a EventTarget object according to the output format.
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Flags
| Flag | Description |
|---|---|
| --id= int64 Required | Event Target ID. |
| --name= string | Event Target name. |
| --workspace-id= int64 | Workspace ID. 0 means the default workspace or site-wide. |
| --apply-to-all-workspaces boolean | If true, this default-workspace target can receive events from all workspaces. |
| --enabled boolean | Whether this Event Target can receive events. |
| --config= object | Event Target configuration. Folder targets accept path and format (json or csv). |
| --delivery-policy= object | Event Target delivery policy. Email and folder targets support batch_interval in seconds, between 600 and 86400. |
Delete Event Target
Command
files-cli event-targets delete
Output
No output is returned.
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Flags
| Flag | Description |
|---|---|
| --id= int64 Required | Event Target ID. |
The EventTarget Object
Some of the commands above return a EventTarget object. The attributes of this object are listed below.
| Attribute | Description |
|---|---|
| id int64 | Event Target ID |
| name string | Event Target name. |
| target_type string | Event Target type. Possible values: email, webhook, slack_webhook, teams_webhook, amazon_sns, google_pubsub, folder |
| workspace_id int64 | Workspace ID. 0 means the default workspace or site-wide. |
| apply_to_all_workspaces boolean | If true, this default-workspace target can receive events from all workspaces. |
| enabled boolean | Whether this Event Target can receive events. |
| config object | Event Target configuration. Folder targets accept path and format (json or csv). |
| delivery_policy object | Event Target delivery policy. Email and folder targets support batch_interval in seconds, between 600 and 86400. |
| created_at date-time | Event Target create date/time. |
| updated_at date-time | Event Target update date/time. |