Webhooks in short
A webhook lets PostBuddy tell your own system what happens to your mail, at the moment it happens. For example: a card is ready, a card needs attention or a card is on its way. Your system receives a short message at a web address you choose, called an endpoint.
Do you need one?
| Situation | What to use |
|---|---|
| You use the Salesforce package | Nothing extra. The Salesforce connection sets up its own endpoint. See Connect Salesforce. |
| Your own CRM or webshop should show the status of each card | A webhook endpoint, built by your developer. |
| You only look at the portal | No webhook needed. |
Set up an endpoint
Owners, Admins and Developers can manage webhooks.
- Open Developers and choose the Webhooks tab.
- Choose New endpoint.
- Enter the URL your developer gives you. It must start with https.
- Add a Description, for example "CRM status updates".
- Under Subscription, choose which messages to send: whole Event families, such as all item events, or Specific events, such as item.completed.
- Under Items, choose Live and test, Live only or Test only.
- Choose Create endpoint and give the signing secret to your developer. It is shown only once.
Your plan may limit the number of endpoints.
Check that it works
Open the menu of an endpoint:
- Send test sends a test message straight away.
- Deliveries shows every message with its attempts, the answer of your system and the contents. Choose Replay to send one again.
If your system does not answer, PostBuddy tries again for 24 hours. After ten messages in a row have failed every attempt, the endpoint is disabled, and Owners, Admins and Developers get a notification.
Fixed the problem? Choose Enable, then open Deliveries and choose Replay missed events to send the messages from the period the endpoint was disabled.
No endpoint possible?
Some systems cannot receive messages. They can fetch the same events from PostBuddy instead. The Events tab shows these events of the last 30 days.
Your developer finds the technical details, such as how to check the signature, in the webhooks guide.
Open a support ticket in the portal. Tell us what you tried and, if you can, which item or Postbatch it is about.