Button Block Addon (buttonBlockAddon)
The purpose of this block is to display interactive buttons in documents source block (interfaceDocumentsSourceBlock).
Usage
As shown in the example below, buttonBlockAddon blocks should be placed inside interfaceDocumentsSourceBlock blocks.
Properties
Property Name | Description | Example | Status |
---|---|---|---|
Button Name (name) | The label (name) of the button as displayed to the user | "Approve", "Reject" | |
UI Class (uiClass) | The UI class of the button | βbtn-approveβ, βbtn-rejectβ, βbtn-linkβ | |
Dialog (dialog) | Determines if a dialog should be opened after the button is clicked | true, false. | |
Dialog Options (dialogOptions) | Will be shown only if the Dialog setting is set to true. |
|
Events
Button block addon events will be automatically added to document source.
API
The API for the buttonBlockAddon features both GET and POST methods:
Example response to the GET request:
The response to the GET request includes all block settings.
Example payload for the POST request:
Where
documentId - selected document identifier.
dialogResult is used for the dialog only.
Last updated