What a webhook is
An endpoint is an address of your own system, starting with https://. Each time something you chose happens in your workspace, we send it a message there: an event. Every event is signed, so your system can check that it is really from us. The developer guide shows how.
Webhooks lists your endpoints: each one’s URL, Description and Status, Enabled or Disabled, with how its last try went.
Add an endpoint
On Webhooks, press Add endpoint.
Type the Endpoint URL, and a description if you like.
The address must start with
https://, be on the public internet, and use the usual port.Press Select events and tick what this address should hear.
Search events finds one by its name. Select all ticks a whole group. How many you chose is counted as you go.
Press Confirm.
The window Its signing secret shows the secret your system checks every event with. Copy it now: it is not shown again.
The events
- A customer’s message arrives.
- A conversation is handed to a person, or closed.
- A contact is added, changes, or opts out.
- A segment changes.
- Meta approves, rejects or pauses a template.
- A campaign is launched, or finishes sending.
- A step of a workflow fails.
- An AI agent goes live, or its changes are published.
- A booking is made, with the CRM.
- A payment goes through.
- A number’s status changes.
An endpoint made on this screen belongs to the workspace and can hear every one of them, the words of a customer’s message included. An endpoint a system made through the API belongs to its key, says so, and hears only what its key may read.
Follow the deliveries
The menu at the end of an endpoint’s row:
| On the screen | What it does |
|---|---|
| Edit | Change its address, description or events. |
| Send test event | Sends a test event now. How it went shows in the delivery log a few seconds later. |
| Delivery log | What was sent in the last 90 days: When, Event, Try, Result, the HTTP answer and the Time it took. |
| New secret | Gives the endpoint a new signing secret, shown once. Events are signed with it at once. |
| Switch off | Nothing more is sent to it until you switch it on. |
| Delete | Deletes the endpoint and its delivery log. |
| On the screen | What it does |
|---|---|
| delivered | Your system answered that it received it. |
| failed, tried again | It did not answer as expected. We try again a few times. |
| not delivered | Every try failed. |
| not sent: address refused | The address could not be called. |
When too many events in a row cannot be delivered, the endpoint is switched off by itself, and says so. Fix the address, send a test event, then switch it on.
Good to know
- A workspace has 20 endpoints at most.
- An endpoint made through a key that is then deleted is switched off. Edit it and save it to make it the workspace’s own, then switch it on.
- What each event contains is in the developer guide.