BotInbox API Reference

Build powerful integrations with the BotInbox REST API. Manage conversations, contacts, messages, and more programmatically.

Base URL: https://your-domain.com/api/v1JSON responses

Authentication

How to authenticate your API requests

All API requests must include an API key in the X-API-Key header.

You can create API keys from the Manage > API Playground page.

Keys use the prefix bi_ followed by 40 random characters.

Example Request
curl -X GET "https://your-domain.com/api/v1/conversations" \
  -H "X-API-Key: bi_your_api_key_here" \
  -H "Content-Type: application/json"

Conversations

Create, list, and manage conversations

Messages

Send and retrieve messages

Contacts

Manage contacts and customer profiles

Labels

Manage conversation labels and tags

Users

List agents and team members

Channels

List communication channels

Webhooks

Subscribe to real-time events

Webhooks allow you to receive real-time HTTP POST notifications when events occur in BotInbox.

Each delivery includes:

- X-BotInbox-Signature header (HMAC-SHA256 of the body using your webhook secret)

- X-BotInbox-Event header with the event type

Available event types:

- conversation.created / conversation.updated / conversation.closed / conversation.assigned

- message.created / message.updated

- contact.created / contact.updated / contact.deleted

- channel.created / channel.updated

- * (all events)