Send API Request

Leverage third-party utilities in a chat.

The Send API Request action supercharges your AI assistant, allowing it to send custom requests to external systems and receive responses. This is useful for utilities like automations, external actions, database updates, and external reporting.

---

Select a Send API Request action from the tree to open its settings:

• HTTP method — the request type:

  • GET — retrieves information about the REST API resource.

  • POST — creates a REST API resource.

  • PUT — updates a REST API resource.

  • DELETE — deletes a REST API resource or related component.

  • PATCH — makes a partial update to a REST API resource.

• URL endpoint — the endpoint to receive requests, which must start with https://.

• Headers — optional Key / Value pairs of content for the request header.

• Resulting variable — the name of the new or existing chat variable whose value will be set in the chat by a GET response.

Press Save to confirm edits.

To test an API request, use a Webchat preview to interact with the AI assistant and trigger the request.