Actions

Get action

Beta
GET
Get an action by its supplied ID

Path parameters

referenceIdstringRequired
The reference ID of the action to get. All other entity ID fields are inferred from the request.

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