Call an API Widget
The Call an API widget allows workflows to make outbound API requests using verified allow-listed endpoints. This widget can be used to fetch external data, trigger third-party services, or process workflow payloads dynamically.

Only verified allow-listed URLs can be used inside the Call an API widget. Ensure the endpoint is configured before creating the workflow.
Example
Say your workflow needs the latest status of an order before it sends an update. The Call an API widget calls your orders API, simplifies the response, and the next Notification Event uses the status in its message.

Steps to configure Call an API Widget
Request
The Request section is used to define the API endpoint and request configuration.
Select the Allowlist URL
The verified endpoint configured for outbound API calls. Choose the one that should be called from the workflow.
Select the HTTP Method
Defines the request operation used while calling the API. Supported methods may include GET, POST, PUT, PATCH and DELETE.
Configure the Content Type
Defines the payload format used in the API request. Common content types include None, application/json, form-data and x-www-form-urlencoded.
Response
The Response section allows you to add a sample API response payload and simplify it using the payload mapper.