FIfiles
event_targets
Event Targets

Create Event Target

Changed on

Create Event Target

post/event_targets

Request

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

Request body multipart/form-data

namestring required

Event Target name.

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 required

Event Target configuration. Fields depend on target_type.

delivery_policyobject

Event Target delivery policy. Email and folder targets support batch_interval in seconds, between 600 and 86400. Slack and Teams support delivery_mode (immediate or subfolder_summary), summary_path (empty string means root), and summary_delay (15–300 seconds, default 60). The summary applies to matching file activity under summary_path; other matching events retain immediate delivery.

target_type'email' | 'webhook' | 'slack_webhook' | 'teams_webhook' | 'amazon_sns' | 'google_pubsub' | 'folder' required

Event Target type.

Example request

{
  "name": "example",
  "workspace_id": 1,
  "apply_to_all_workspaces": true,
  "enabled": true,
  "target_type": "webhook"
}

Response

The EventTargets object.

idinteger

Event Target ID

namestring

Event Target name.

target_type'email' | 'webhook' | 'slack_webhook' | 'teams_webhook' | 'amazon_sns' | 'google_pubsub' | 'folder'

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. Fields depend on target_type.

delivery_policyobject

Event Target delivery policy. Email and folder targets support batch_interval in seconds, between 600 and 86400. Slack and Teams support delivery_mode (immediate or subfolder_summary), summary_path (empty string means root), and summary_delay (15–300 seconds, default 60). The summary applies to matching file activity under summary_path; other matching events retain immediate delivery.

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": "webhook",
  "workspace_id": 1,
  "apply_to_all_workspaces": true,
  "enabled": true,
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}

Changes