Send API

Action — Sends a request to an external endpoint and receives the response. Supports GET, POST, PUT, DELETE, and PATCH.

What it does

Calls an external API mid-chat and stores the response in a variable for use by downstream actions.

When to use it

To bring live external data into a chat — looking up a complaint status, fetching account details, or pushing data out to another system.

Settings

Setting	Description
HTTP method	The request type: GET (retrieve), POST (create), PUT (update), PATCH (partial update), DELETE (delete).
URL endpoint	The endpoint receiving the request. Must start with https://.
Headers	Key / Value pairs for the request header, e.g. for authentication tokens. Optional.
Payload (JSON)	For POST, PUT, PATCH, and DELETE requests. Enter directly or as a chat script Python expression.
Resulting variable	The chat variable that stores the response. Must start with a letter and contain only letters, numbers, or underscores.

Press Save to confirm edits.

Outcome branches

The action branches into Success, Error, and Timeout. Nest subsequent actions under each as needed.

Example

Send API
• Method:   GET
• URL:      https://api.example.com/complaints/{complaint_ref}
• Result:   complaint_status

A following Branch or Send message can then use complaint_status.

Related

Set variableBranchSQL query