Event Targets

An EventTarget is a delivery destination for EventRecords.

List Event Targets

SDK Method

Files::EventTarget.list

Return Object

List<EventTarget>

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

begin
  event_targets = Files::EventTarget.list
  event_targets.auto_paging_each do |event_target|
    # Operate on event_target
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Event Target

SDK Method

Files::EventTarget.find

Return Object

EventTarget

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Event Target ID.

Example Request

begin
  event_target = Files::EventTarget.find(id)
  # Operate on event_target
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create Event Target

SDK Method

Files::EventTarget.create

Return Object

EventTarget

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDefaultDescription
name
string
Required		Event Target name.
workspace_id
int64		0Workspace ID. 0 means the default workspace or site-wide.
apply_to_all_workspaces
boolean		falseIf true, this default-workspace target can receive events from all workspaces.
enabled
boolean		trueWhether 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

Example Request

begin
  event_target = Files::EventTarget.create(
    name: "example",
    config: "example",
    target_type: "example"
  )
  # Operate on event_target
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Update Event Target

SDK Method

event_target.update

Return Object

EventTarget

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
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.

Example Request

begin
  # Find the event_target object by its id.
  event_target = Files::EventTarget.find(id)
  event_target.update(
    name: "example"
  )
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete Event Target

SDK Method

event_target.delete

Return Object

nil

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

begin
  # Find the event_target object by its id.
  event_target = Files::EventTarget.find(id)
  event_target.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The EventTarget Object

Some of the methods above return a EventTarget object. The attributes of this object are listed below.

AttributeDescription
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.