workflow_actions_short

workflow_rule_action_values object response data

Name	Type	Description
code	String	The code of the Workflow Rule Action which can either be UPDATE INFORMATION, SEND ALERTS, SET APPROVALS, TRIGGER WEBHOOKS.
field	String	The field which is related to the Workflow Rule Action but only if the action has a code UPDATE INFORMATION. It defines the Entity field being updated by the Workflow Rule Action.
value	String	The value to which the Entity instance will be updated to. Applicable only if the action has a code UPDATE INFORMATION
webhook_definitions	Set of Webhook Definition Objects	The set of Webhook Definitions which are triggered by the action. Applicable only if the action has a code TRIGGER WEBHOOKS.
approval_definitions	Set of Approval Definition Objects	The set of Approval Definitions which are triggered by the action. Applicable only if the action has a code SET APPROVALS,
alert_definitions	Set of Alert Definition Objects	The set of Alert Definitions which are triggered by the action. Applicable only if the action has a code SEND ALERTS

Referred Objects Response Data

webhook_definition object response data

Name	Type	Description
id	String	The ID of the retrieved webhook definition
alternative_code	String	The alternative code of the retrieved webhook definition
name	String	The name of the retrieved webhook definition
life_cycle_state	String	The life cycle state of the retrieved webhook definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE

alert_definition object response data

Name	Type	Description
id	String	The ID of the retrieved alert definition
alternative_code	String	The alternative code of the retrieved alert definition
name	String	The name of the retrieved alert definition
life_cycle_state	String	The life cycle state of the retrieved alert definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE
type	String	The type of the alert definition which can be EMAIL or SMS

approval_definition object response data

Name	Type	Description
id	String	The ID of the retrieved approval definition
alternative_code	String	The alternative code of the retrieved approval definition
name	String	The name of the retrieved approval definition
life_cycle_state	String	The life cycle state of the retrieved approval definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE