Webhooks
Overview
Receive signed Scribeless events in your own systems.
Use webhooks when your integration needs to react to Scribeless events without polling the API.
Scribeless currently supports one webhook event:
| Event | When it fires |
|---|---|
qr_code.scanned | After Scribeless records a scan for a generated Smart QR code. |
Webhook management endpoints use the same X-API-Key authentication as the rest of the Scribeless API. Webhook deliveries are sent as signed HTTPS POST requests to the URL you subscribe.
How it works
- Create a webhook subscription for
qr_code.scanned. - Store the signing secret returned by Scribeless.
- Add Smart QR placeholders to your HTML recipient or template.
- Verify incoming webhook signatures with the raw request body.
- Process each event idempotently.
The person scanning the QR code is redirected to the QR destination even if webhook delivery fails.
Pages
| Page | Use it for |
|---|---|
| Manage subscriptions | Create, list, pause, update, and delete webhook subscriptions. |
| QR scan events | Understand the qr_code.scanned payload, delivery headers, and signature verification. |
URL requirements
Webhook URLs must use HTTPS and resolve to a public IP address. Localhost, private network, and link-local addresses are rejected.