A webhook is a message we POST to your app’s address when something happens in your company, so the other app does not have to keep asking.
-
Step 1: Add an endpoint
In Administration → Settings → API & webhooks, under Webhooks, click Add endpoint.
-
Step 2: Enter the address
Fill in the Endpoint URL (it must be a public https:// address) and an optional Description.
-
Step 3: Choose the events
Under Events, tick the ones you need, or All events, including ones added later.
-
Step 4: Copy the signing secret
After saving, the Signing secret is shown once. Copy it into the receiving app so it can check that each message really came from us.
-
Step 5: Test it
Click Send test event and check the Delivery log.
Available events
- Contacts: a contact was created or updated.
- Invoices: issued, paid in full, voided. Quotations: accepted.
- Payments: a payment or receipt was posted.
- Bills: received (posted), paid in full. Expenses: an expense was recorded.
- Stock: an item fell to or below its reorder level.
- Leave: a leave request was created.
Deliveries and retries
- Your app should answer with a 2xx status within 10 seconds. Anything else counts as a failure.
- Failed deliveries are retried automatically, up to six attempts over several hours, with longer waits each time.
- Open an endpoint with Manage to see the Delivery log: each event with its Payload, your server’s Response and a status of Delivered, Failed or Pending. Click Resend to send one again.
- Untick Send events to this endpoint to pause it, or click Remove to delete it. An endpoint that keeps failing for a long time is switched off automatically.
Verify the signature
Each delivery has the header X-Webhook-Signature: t=<timestamp>,v1=<signature>. Compute HMAC-SHA256 of “<timestamp>.<raw body>” with your signing secret and compare it with v1; reject timestamps older than 5 minutes. X-Webhook-Id stays the same across retries, so use it to ignore duplicates.
Related guides
Ask about the product
Ask what the software can do, how a task works, or which countries and languages it supports. Answers come from these guides.
Thinking…
The AI assistant is not available right now. Search the guides or talk to our team. Contact support
AI can make mistakes. Check the linked guides.
Still need help?
Our support team reads every message and answers in plain language.
Contact support