Guide

Connecting to a REST API

Use the REST connector to send data from any flow to an API. The example uses a fictional ERP API.

01

Create the connection

Add a REST connector and set the base URL, for example https://api.acme-erp.example/v2.
02

Authenticate

Choose API key, Basic or Bearer token. The secret is stored in the vault. OAuth 2.0 is in development.
03

Set the operation

Choose the method and the path, for example POST /invoices.

04

Map the body

Map fields from your source message to the request body.

{
  "customerId": "C-1001",
  "currency": "USD",
  "lines": [{ "sku": "STORAGE-20FT", "qty": 3 }]
}

05

Handle the response

Save the returned id on the message. Send 4xx errors to the error path; 5xx and 429 are retried.

Want us to build it with you?

Book a session and bring your own files.