Action

Action

An actionable step that can be executed to solve the issue.

Fields
button_label

string

Label of the action button.

is_available

bool

Controlling whether the button is active or disabled. The value is 'false' when the action was already requested or is not available. If the action is not available then a reason will be present. If (your) third-party application shows a disabled button for action that is not available, then it should also show reasons.

reasons[]

Reason

List of reasons why the action is not available. The list of reasons is empty if the action is available. If there is only one reason, it can be displayed next to the disabled button. If there are more reasons, all of them should be displayed, for example in a pop-up dialog.

Union field action . An actionable step that can be executed to solve the issue. action can be only one of the following:
builtin_simple_action

BuiltInSimpleAction

Action implemented and performed in (your) third-party application. The application should point the business to the place, where they can access the corresponding functionality or provide instructions, if the specific functionality is not available.

external_action

ExternalAction

Action that is implemented and performed outside of (your) third-party application. The application needs to redirect the business to the external location where they can perform the action.

builtin_user_input_action

BuiltInUserInputAction

Action implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the business as specified for given action. They can trigger the action only when they provided all required inputs.