Skip to main content
Webhooks let Biqli notify your server when a workspace event occurs. Instead of repeatedly asking Biqli for changes, your application exposes an endpoint and Biqli sends an HTTP request to it.

​
Supported events

​
How delivery works

  1. You create a webhook endpoint in Workspace settings -> Webhooks.
  2. You select one or more event types.
  3. Biqli creates an event after the product change commits.
  4. Biqli sends a signed JSON POST request to your URL.
  5. Your server verifies the signature and event identity.
  6. Your server stores or queues the event and returns HTTP 2xx.

​
Common envelope

Every request has the same outer shape:

​
Delivery headers

Always verify Biqli-Signature against the exact raw body before processing the JSON.

​
Important guarantees and responsibilities

  • Biqli can deliver an event more than once. Deduplicate with the envelope id.
  • Events can arrive later than the product action because delivery is queued.
  • Return 2xx only after your system has safely accepted the event.
  • Process expensive work asynchronously after acceptance.
  • Do not depend on delivery order across different events.
  • Keep the signing secret private and rotate it by replacing the endpoint if compromised.
Continue with Create an endpoint, then implement signature verification.