Getting started
Webhooks let Simplicate notify your systems the moment something happens, so you do not have to poll the API for changes.
For more information on webhooks in the Simplicate, see the support documentation.
What is a webhook?
A webhook is an HTTP callback: when an event occurs, the source sends an HTTP POST to a URL you have registered. The request body contains a JSON payload describing the event. Your endpoint receives the payload, does whatever work it needs to do, and responds with 2xx to acknowledge receipt.
How webhooks work in Simplicate
In Simplicate you can configure one or more webhook targets, each listening for the events you select. When a matching event occurs — for example a sale progress being updated — Simplicate sends an HTTP POST request to every target subscribed to that event.
Each request carries an X-Webhook-Signature header so you can verify the request came from Simplicate, as well as an X-Simplicate-Domain header identifying the Simplicate environment the event originated from.
Your endpoint should respond with an HTTP 2xx status as quickly as possible. Simplicate treats non-2xx responses as failures and may retry delivery.
For a list of available events with their payload schema see Outbound webhooks.
Verify every request
Your webhook URL is publicly reachable, which means anyone who discovers it could send it forged requests. Always verify the X-Webhook-Signature header before trusting a payload.
See Verifying signatures for how you can verify the signatures.