API Request in flows

Send data to your own system and use the response in a flow.

  1. Add an API Request card and click its URL field.
  2. Choose GET, POST, PUT, PATCH or DELETE, and enter the URL.
  3. Fill in Params, Headers and Body as your system needs. Use attributes like $firstname.
  4. Click Test to try the request. Attributes about the customer aren't filled in during a test.
  5. Under Capture response in Attribute, pick an attribute and enter where the value is in the response, for example data.id.
  6. Click Save.

Choose the next step by status code

Add a Custom Status Code, like 200, to give that response its own path. Anything else goes down Status Fallback, including a request that couldn't complete.

Keep API keys safe

Add secrets in Flows under Global Attributes, then use them in API Request as $name or {{global.name}}. They're never put into messages to customers.

Requests must go to a public address and time out after 10 seconds. Redirects aren't followed, and a request is never repeated automatically.