Call an API Widget within a Workflow

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

Configure the Request section.

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

Select the Allowlist URL.

Choose the verified allow-listed endpoint that should be called from the workflow.

Select the HTTP Method.

This defines the type of API request that will be executed.

Supported methods may include:

• GET
• POST
• PUT
• PATCH
• DELETE

Configure the Content Type.

The content type determines the format of the request payload being sent to the API.

Common content types include:

• None
• application/json
• form-data
• x-www-form-urlencoded

Configure Query Parameters (Optional).

Query parameters are appended to the API URL and are typically used for filtering, searching, or passing request-specific values.

Example:

1
{
2
  "userId": "$input.user.id"
3
}

Configure Headers (Optional).

Headers are used to send additional metadata with the API request.

Common examples include:

• Authorization tokens
• API keys
• Custom request headers

Example:

1
{
2
  "Authorization": "Bearer <token>"
3
}

Configure the Response section.

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

Users can provide response data in:

• JSON format
• FORM format

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

Example Response:

1
{
2
  "user": {
3
    "id": 101,
4
    "name": "John Doe"
5
  }
6
}

Simplified Output:

1
{
2
  "user.id": 101,
3
  "user.name": "John Doe"
4
}