Event Channels

An EventChannel is a named grouping of EventSubscriptions.

List Event Channels

Command

files-cli event-channels list

Output

Outputs a list of EventChannel 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

Example Request

files-cli event-channels list

Show Event Channel

Command

files-cli event-channels find

Output

Outputs a EventChannel 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

FlagDescription
--id=
int64
Required		Event Channel ID.

Example Request

files-cli event-channels find \
  --id=1

Create Event Channel

Command

files-cli event-channels create

Output

Outputs a EventChannel 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

FlagDefaultDescription
--name=
string
Required		Event Channel name.
--workspace-id=
int64		0Workspace ID. 0 means the default workspace.
--description=
string		Event Channel description.
--enabled
boolean		trueWhether this Event Channel can dispatch events.
--default-channel
boolean		falseWhether this Event Channel is the default destination for newly published events.

Example Request

files-cli event-channels create \
  --name="example"

Update Event Channel

Command

files-cli event-channels update

Output

Outputs a EventChannel 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

FlagDescription
--id=
int64
Required		Event Channel ID.
--name=
string		Event Channel name.
--workspace-id=
int64		Workspace ID. 0 means the default workspace.
--description=
string		Event Channel description.
--enabled
boolean		Whether this Event Channel can dispatch events.
--default-channel
boolean		Whether this Event Channel is the default destination for newly published events.

Example Request

files-cli event-channels update \
  --id=1 \
  --name="example"

Delete Event Channel

Command

files-cli event-channels 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

FlagDescription
--id=
int64
Required		Event Channel ID.

Example Request

files-cli event-channels delete \
  --id=1

The EventChannel Object

Some of the commands above return a EventChannel object. The attributes of this object are listed below.

AttributeDescription
id
int64		Event Channel ID
name
string		Event Channel name.
workspace_id
int64		Workspace ID. 0 means the default workspace.
description
string		Event Channel description.
enabled
boolean		Whether this Event Channel can dispatch events.
default_channel
boolean		Whether this Event Channel is the default destination for newly published events.
created_at
date-time		Event Channel create date/time.
updated_at
date-time		Event Channel update date/time.