API Endpoints

The API Endpoint step lets your workflows call any external REST API. Use it to fetch data from third-party services, push updates to external systems, or integrate with any service that has an API.

Adding an API Endpoint Step

Drag the API Endpoint step from the Integrations category onto your canvas.

Configuration

• URL — The full API endpoint URL. Use variable chips to insert dynamic path parameters.
• Method — GET, POST, PUT, PATCH, or DELETE.
• Headers — Add request headers like Authorization tokens, Content-Type, and custom headers.
• Body — For POST, PUT, and PATCH requests, define the request body. Use variable chips to insert dynamic data from upstream steps.
• Response mapping — Define which fields from the API response should be extracted as output variables for downstream steps.

Authentication

Common patterns for authenticating API requests:

• Bearer token — Add an Authorization header with the value "Bearer {{token}}."
• API key — Add the key as a header or query parameter, depending on the API's requirements.
• Basic auth — Add an Authorization header with a Base64-encoded username:password string.

Error Handling

Connect an Error step after the API Endpoint to catch failures — timeouts, 4xx/5xx responses, or network errors. This lets your workflow respond gracefully instead of stopping.

Tips

• Test API calls with sample data before connecting them to the rest of your workflow.
• Use the Transform step after an API Endpoint to reshape the response data into a format your downstream steps expect.
• Keep authentication tokens in your ERP integrations settings rather than hardcoding them in the step configuration.