Actions

Create or update an action

Beta
PUT
Update an action or create it if it doesn't exist

Request

This endpoint expects an object.
description
stringRequired
The description of the action. This helps Maven decide when to trigger the action and is not displayed directly to the end user.
entityId
objectRequired
ID that uniquely identifies this action
name
stringRequired
The name of the action
requiredUserContextFieldNames
set of stringsRequired
The names of the user context fields required by the action
userFormParameters
list of objectsRequired
userInteractionRequired
booleanRequired
Whether the action requires user interaction to execute
buttonName
stringOptional
When user interaction is required, the name of the button that is shown to the end user to execute the action

Response

This endpoint returns an object
description
string
The description of the action. This helps Maven decide when to trigger the action and is not displayed directly to the end user.
entityId
object
ID that uniquely identifies this action
name
string
The name of the action
requiredUserContextFieldNames
set of strings
The names of the user context fields required by the action
userFormParameters
list of objects
userInteractionRequired
boolean
Whether the action requires user interaction to execute
buttonName
stringOptional
When user interaction is required, the name of the button that is shown to the end user to execute the action

Errors