REST reference
Every endpoint, generated from the OpenAPI spec.
All endpoints are relative to the base URL and require a bearer API key. The reference below is generated from the live OpenAPI document, which you can also download for client generation.
Chatbots
List the agents in your workspace.
Chat
Send messages and receive replies (JSON or Server-Sent Events).
Conversations
Read conversation history from every channel.
Leads
Leads captured by forms, email capture or the `capture_lead` tool.
Sources
Manage knowledge sources and trigger reindexing.
Threads
Create, read, update and reply to threads (every conversation gets a TB- reference once it reaches Threads).
Contacts
Look up and upsert the people you support.
Webhook payload
Payload POSTed to your webhook endpoints. Verify the `X-Threadbox-Signature` header (`t=<unix>,v1=<hex HMAC-SHA256 of "<t>.<raw body>" using your endpoint secret>`).
idstringtype"conversation.created" | "conversation.closed" | "message.created" | "lead.created" | "escalation.created" | "action.failed" | "thread.updated" | "thread.resolved" | "thread.target_breached" | "csat.received" | "contact.created" | "rule.webhook"createdAtstring (date-time)dataobject