v1actions

Returns a list of all actions.

Query parameters
exclude_attributes
array[string]
List of attributes to exclude
include_attributes
array[string]
List of attributes to include
limit
integer
Number of actions to get
offset
integer
Number of actions to offset
id
array[string]
Action id filter
name
string
Action name filter
pack
string
Action pack name filter
tags
string
Action tags name filter
Responses

List of actions

array[object]
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.

Create a new action.

Request body

Action content

object
pack
string
The content pack this action belongs to.
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
data_files
array[object]
Optional action script and data files which are written to the filesystem.
file_path
string
Path to the file relative to the pack actions directory (e.g. my_action.py).
required
content
string
Raw file content.
required
Responses

Single action being created

object
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.

Get code of the action's entry_point.

Path parameters
ref_or_id
string
Entity reference or id
required
Responses

Entry point code

string

Returns a list of all the actions with runner parameters included.

Query parameters
exclude_attributes
array[string]
List of attributes to exclude
include_attributes
array[string]
List of attributes to include
limit
integer
Number of actions to get
offset
integer
Number of actions to offset
id
string
Action id filter
name
string
Action name filter
pack
string
Action pack name filter
Responses

List of actions

array[object]
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.

Get one action with runner parameters included.

Path parameters
ref_or_id
string
Entity reference or id
required
Responses

Action requested

object
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
Path parameters
action_id
string
Entity id
required
Responses

An object containing action parameters

object
parameters
object
Input parameters for the action.
Path parameters
ref_or_id
string
Entity reference or id
required
Responses

Action requested

object
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
Path parameters
ref_or_id
string
Entity reference or id
required
Request body

Action content

object
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
data_files
array[object]
Optional action script and data files which are written to the filesystem.
file_path
string
Path to the file relative to the pack actions directory (e.g. my_action.py).
required
content
string
Raw file content.
required
Responses

Action updated

object
id
string
The unique identifier for the action.
ref
string
System computed user friendly reference for the action. Provided value will be overridden by computed value.
uid
string
name
string
The name of the action.
required
description
string
The description of the action.
enabled
boolean
Enable or disable the action from invocation.
runner_type
string
The type of runner that executes the action.
required
entry_point
string
The entry point for the action.
pack
string
The content pack this action belongs to.
parameters
object
Input parameters for the action.
tags
array[object]
User associated metadata assigned to this object.
notify
object
Notification settings for action.
on-complete
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-failure
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
on-success
object
message
string
Message to use for notification
data
object
Data to be sent as part of notification
routes
array[string]
Channels to post notifications to.
channels
array[string]
Channels to post notifications to.
Path parameters
ref_or_id
string
Entity reference or id
required
Responses

Action deleted

null