Skip to navigation

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.

Request

Configure the outbound API request.

Response

Configure and simplify the API response payload.

Call an API widget

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.

Call an API fetching order details

SettingValue in this example
Allowlist URLorders-api
HTTP MethodGET
Content TypeNone
Query Parametersorder_id = {{$input.body.order_id}}
HeadersAuthorization: Bearer <token>
Simplified value used next{{order.status}}, which is shipped

Steps to configure Call an API Widget

1

Add the widget

Drag and drop the Call an API widget into the workflow and connect it to the required workflow step.

Request

The Request section is used to define the API endpoint and request configuration.

1

Select the Allowlist URL

The verified endpoint configured for outbound API calls. Choose the one that should be called from the workflow.

2

Select the HTTP Method

Defines the request operation used while calling the API. Supported methods may include GET, POST, PUT, PATCH and DELETE.

3

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.

4

Configure Query Parameters (optional)

Key-value pairs appended to the request URL, typically used for filtering, searching, or passing request-specific values.

{
"userId": "$input.user.id"
}
5

Configure Headers (optional)

Additional metadata sent along with the API request, such as authorization tokens, API keys or custom request headers.

{
"Authorization": "Bearer <token>"
}

Response

The Response section allows you to add a sample API response payload and simplify it using the payload mapper.

1

Add a sample response

Provide the response data in JSON or FORM format.

2

Simplify the response

Use the Simplify option to flatten nested API response payloads for easier mapping within workflows.

{
"user": {
"id": 101,
"name": "John Doe"
}
}