Skip to content

How do I register a webhook?

Who can do this

Owner or Admin

Webhooks deliver events from the Console to a URL you control — useful for syncing customer data, posting to Slack, or triggering automation when something changes.

Steps

  1. Open Settings → Webhooks.
  2. Click Add Webhook.
  3. Fill in:
    • Target URL — must be HTTPS and reachable from our network.
    • Events — pick the event types you want delivered (e.g. user.invited, tenant.created, invoice.issued).
    • Signing secret — generated automatically. Copy and store it in your receiving service so you can verify request signatures.
  4. Click Save.
  5. Use Send Test on the webhook row to send a synthetic payload and confirm your endpoint accepts it.

Result

Matching events are queued and delivered to your URL with an HMAC signature in the X-Signature header. Failed deliveries are retried with exponential backoff for up to 24 hours.