Webhooks
A webhook is an automatic notification. Instead of your system repeatedly asking us "anything new?", we send the details to a web address you own the moment something happens on the account — a text arrives, a call ends, and so on.
There are five kinds of event you can be notified about:
| Event | We notify you when |
|---|---|
AccountSMS | A text message is sent or received |
AccountRealTimeCalls | A call changes state — while it is still going on |
AccountEndedCalls | A call finishes, with the full breakdown of what happened |
UserEndedCalls | A call finishes, from one user's point of view |
AccountAITranscription | A call's transcript and summary are ready |
How it works
- Subscribe — tell us the web address to notify and which kind of event you want. You can do this through the API or in the portal.
- Receive — when that event happens, we send its details to your address.
- Reply quickly to confirm you got it, then do the real work afterward.
What to know first
danger
- We send each event only once. If your address is down or too slow when an event happens, that notification is gone for good — there is no second attempt. See Delivery.
- The message doesn't prove it came from us. Nothing in it guarantees it is really from Telebroad, so don't trust it blindly. See Verifying.
- One subscription covers one kind of event. Want SMS and ended calls? Set up two — the same address is fine for both.
A minimal receiver
Your address has to reply within 30 seconds, so confirm you received the event first, then do the slower work separately. If your reply comes too late, we never send that notification again — so you never find out that event happened.
app.post('/telebroad/hook', express.json(), (req, res) => {
res.sendStatus(200);
queue.push(req.body);
});