Developers
Set up a webhook
Get an HTTPS POST request from SignQuick when a document event happens.
On SignQuick Pro and Team, add a webhook in Settings, then Integrations, to receive a signed HTTPS POST request when a document event happens.
Who can use this feature?
- Plans
- Pro, with up to 3 webhooks, and Team, with up to 10. At the limit, Add Webhook is disabled. On Free, Integrations shows Webhooks Require a Paid Plan.
- Who can do it
- Owners, Admins and members granted Manage integrations.
- Before you start
- An HTTPS endpoint that accepts POST requests.
Add a webhook
- Step 1: In the sidebar, select Settings, the gear icon next to your name.
- Step 2: Select Integrations.
- Step 3: Select Add Webhook.
- Step 4: Enter the Endpoint URL (HTTPS required).
- Step 5: Add a Description (optional) to tell your webhooks apart.
- Step 6: Under Events, select the events you want, or Select all.
- Step 7: Select Create Webhook.
- Step 8: Copy the secret from the Webhook Signing Secret — Copy it now! banner.
- Step 9: Select Send test event on the webhook's card.
Result: SignQuick shows Test succeeded with your endpoint's status code. Test events don't appear in Delivery attempt history.
Verify each delivery
Each delivery has an X-SignQuick-Signature header in the form sha256=<hex>. It is a hash-based message authentication code (HMAC). The X-SignQuick-Event header names the event.
- Step 1: Compute the HMAC SHA-256 of the raw request body with your webhook secret.
- Step 2: Put sha256= in front of the hex digest.
- Step 3: Compare the result with the header in constant time.
- Step 4: Save the verified delivery before you return a 2xx status.
- Step 5: Skip any X-SignQuick-Delivery-ID you already processed.
Result: Delivery attempt history shows Attempt succeeded for the delivery.
Common questions
Which events can I receive?
You can get an event when a document is created, sent, viewed, signed, completed, declined, voided or expired. There is also one for a finished bulk send. You choose them for each webhook under Events.
What happens when deliveries fail?
SignQuick retries a failed delivery a few times, and repeated failures disable the webhook. A delivery that used up its attempts can be replayed once from Review replay and recovery.