Execute API Call

Block Information

Available in: Page Flow and Cloud Flow

Toolbox Category: Connections

Block Type: Regular

The Execute API Call block is used to communicate with other apps including third-party software services.

The block consists of the following (from top to bottom)::

• Connection Name: Value Parameter that accepts a text value representing the name of the connection to use.

• Data: Optional Value Parameter that accepts an object value representing the request data to be used for the API Call. The properties of the provided object will be combined with the Request Data setting in the connection.

• Params: Optional Value Parameter that accepts an object value representing the request parameters to be used for the API Call. The properties of the provided object will be combined with the Request Parameters setting in the connection.

• Success Tasks: a Flow Parameter where you connect blocks that specify what you want done when the operation completes successfully. The Connection Data block can be used to access the output of the API call.

• Fail Tasks: a Flow Parameter where you connect blocks that specify what you want done when the operation reports an error. The Connection Error block can be used to access the error information.

---

Usage Example

The image below shows an example of the Execute API Call block.

Example of Execute API Call block