Webhooks
On Scale, a webhook sends a signed message to your own address when a call is completed, a booking is made, a text arrives or a new contact appears.
- Who can do it
- Owners and managers
- Plan
- Scale
- Checked
Add an endpoint
- Step 1: Open Settings, then Developers, and scroll to Webhooks.
- Step 2: Type your address in Address for a new endpoint. It must start with https:// and be reachable from the internet.
- Step 3: Tick the events to send.
- Step 4: Press Add endpoint.
- Step 5: Copy the signing secret. It is shown once.
- Step 6: Press Send test event to check your code before real events arrive.
The events
- call.completed: a call has ended and its summary, outcome and estimated value are ready.
- booking.created: an appointment was booked, by the receptionist or by your team.
- message.received: a caller sent a text to one of your numbers.
- contact.created: a new caller or texter was added to your contacts.
- lead.received: someone left their details on your website's form or chat. Rolling out: offered only once the website form and chat are switched on for your account.
What your endpoint must do
- Answer with a 2xx status within 10 seconds. A redirect counts as a failure.
- Check the signature in the 1bb-signature header before you trust a message. The Developers page shows how.
- Use the 1bb-delivery header to ignore a message you have already handled. The same delivery can arrive twice.
Retries and failures
- A failed delivery is tried again up to 8 times over about a day.
- If nothing gets through for about a day, we turn the endpoint off and email the account owner once.
- Events sent while it was failing are not sent again. Catch up through the API, then press Turn on.
- Recent deliveries lists the last 25 messages with their status. Records are kept for 30 days.
Limits
- Up to 5 endpoints added by hand.
- Send test event works 10 times a minute.
- The address must be a public https host name on the standard port. Private addresses and other ports are refused.
- Spam calls and imported contacts send no event.
In your portal
Opens app.1bb.ai/settings/developers in your portal. You may be asked to sign in first.