Connect your own systems with Custom APIs

Step 1: Create the integration

1. 1Open Integrations, select the Custom APIs tab, then New integration.
2. 2Enter a Name, for example Order Management API.
3. 3Enter the Base URL, starting with https://. Every action is appended to it.
4. 4Add a Description that tells your bots what this system is and what it covers.
5. 5Under Default headers, add headers sent with every action, typically Authorization with your token.
6. 6Select Create integration.

Step 2: Add actions

1. 1Open the integration and select Add action.
2. 2Give it an Action name, for example Get order status.
3. 3Under Request, choose the method (GET, POST, PUT, PATCH or DELETE) and the path, such as /orders/{{order_id}}. The Full URL preview updates as you type.
4. 4In When to call it, describe when the bot should use it and what to collect first, for example "Call when a customer asks where their order is. Collect the order ID first."
5. 5For POST, PUT and PATCH, write the Request body with {{variable}} placeholders. The bot fills them from the conversation, and they are listed under Variables the bot will fill.
6. 6Optionally, under Save the response, map fields from the reply to a contact attribute or column.
7. 7Select Test call, then Add action.

Deleting safely

The library shows each integration's number of actions and which bots use it. If you delete something still in use, a warning names the bots that would break. For an integration you can choose Archive instead, which keeps it out of the way without breaking anything.