Acknowledgement action is used to receive user consent
Acknowledgment actions are used in combination with other actions, where this action is the unioned action, in order to have the user acknowledge content or a behavior like a signature.
No products are required to use this action.
This action pairs well with the following actions.
State
After resolution and this actions status is 'resolved' you will be able to find the time 'at' (in milliseconds) and the channel by which, the user made their acknowledgment. If user made acknowledgment through web, you'll have an IP address and If acknowledgment made through message, you'll have a message ID.
Union
When this action is unioned to another action, it will no longer render a button for the user to 'acknowledge' the behavior. Instead, the targeted action will inform this action that acknowledgment has been granted.
Macro level details for how union attribute behaves can be found within the Union documentation.
Features (required)
Name | Type | Description | Rules |
---|---|---|---|
title | string | (required) A short description of the item to be acknowledged used within message. An example of usage would be Reply X123 to acknowledge {Title} . Examples: "Acme Code of Conduct". | MaxLength: 64 MinLength: 1 Pattern: ^(?!\s*$).+ |
Example
Below is an example payload for adding an action to a business process or blueprint.
{
"type": "acknowledgement",
"union": 0,
"features": {
"title": "Acme Code of Conduct"
}
}