Build on relay.
A REST API described in OpenAPI 3.1, signed webhooks, and two embeds: the Messenger and the feedback board. Read and write customers, boards, News and help content from your own code.
The basics
Scoped API keys
Each key is read, send or admin, and has its own rate limit.
Safe retries
An Idempotency-Key on every write: retry as often as you need, it applies once.
Long jobs
Work that takes time answers with an operation id you can poll.
OpenAPI 3.1
A hosted reference at /v1/docs, and a spec to generate your client.
What the API covers
The same objects your team works with in the app, under the same tenancy and access rules.
Linked WhatsApp numbers have their own endpoints: numbers, chats, messages, media and their conversations. relay links a number the way WhatsApp Web does and isn’t an official WhatsApp product; read the Acceptable Use Policy first. Acceptable Use Policy
/customersProfiles, attributes, tags and consent/appsYour apps, their users and companies/boardsPosts, comments and user erasure/apps/{id}/newsNews for the Messenger/helpHelp center content/membersYour team/tagsTags across the inbox/webhooksEndpoints and deliveries
Webhooks
Point an endpoint at relay and get an event for what happens in your boards, Messenger and News.
- Signed with HMAC-SHA256 over the timestamp and the raw body
- Retried for 24 hours when your endpoint fails
- A delivery log for each endpoint in the app
customer.updatedA profile changesmessenger.conversation.createdA Messenger conversation opensmessenger.message.createdA Messenger message arrivesboard.post.createdA post is publishedboard.post.statusA post changes statusboard.comment.createdSomeone commentsnews.publishedA News post goes live
Conversation, message, chat and call events are sent for linked WhatsApp numbers.
Your first call in a few minutes.
Create a workspace, add an API key in Settings, and call the API with it.