Skip to content
14-day free trial, no card9 languages176 business types · 50 apps
EN· USD
Try a live demoStart free trial

Webhook endpoints and subscriptions

An endpoint is a URL, a list of events and a signing secret. Create it in the admin or, on the hosted platform, through the API.

  • about 6 min

An endpoint = URL + subscribed events + signing secret. The secret (whsec_…) is shown once and stored AES-GCM encrypted. Create endpoints under Admin → Settings → Integrations & API.

  • Subscribe to single events (invoice.paid), a group (invoice.*) or everything including future events (*).
  • The URL must start with http:// or https://. On the hosted platform private network addresses are refused.
  • The Send test event button sends webhook.test so you can check your receiver.

Create an endpoint through the API (hosted platform)

With the webhooks:write scope you can manage endpoints from code; the signing secret is in the answer once.

POST /webhooks
curl -X POST "$ZMLE_BASE/webhooks" \
  -H "Authorization: Bearer $ZMLE_KEY" -H "content-type: application/json" \
  -d '{"name":"CRM sync","url":"https://crm.example.com/hooks/zmle","events":["inquiry.created","invoice.*"]}'

# list (no secrets) and delete
curl -s "$ZMLE_BASE/webhooks" -H "Authorization: Bearer $ZMLE_KEY"
curl -X DELETE "$ZMLE_BASE/webhooks/<id>" -H "Authorization: Bearer $ZMLE_KEY"
Store the secret in your receiver's secret store or environment. If it leaks, delete the endpoint and create a new one.
A marketplace integration gets its endpoint automatically: at install the platform creates one endpoint for the events in app.json, which must be listed one by one (no invoice.*, no *). Uninstall deletes it.

Written from: docs/API.md, src/lib/integrations/webhooks.ts, src/lib/integrations/events.ts, src/lib/integrations/openapi.ts, docs/DEVELOPERS/INTEGRATION-SPEC.md, examples/marketplace/integration-hello-sync/app.json