Articles on: Integrations

How to Secure a Webhook with Signature Authentication

How to Secure a Webhook with Signature Authentication


In this article:

  • Overview
  • How to turn on signature authentication
  • How to regenerate the secret key
  • How the signature works
  • Things to keep in mind
  • FAQs
  • Who can do this


Overview


Signature authentication lets your receiving endpoint verify that a webhook request genuinely came from SuperPath and not from someone impersonating it. When it is turned on, SuperPath signs every delivery and adds a signature to the request header. Your endpoint recomputes the same signature using a shared secret key and only trusts the request if the two match.


Signature authentication is optional and is configured per webhook in the Add Webhook or Update Webhook window under Settings → Integrations → Manage Webhooks.


Note: Webhooks are only available on paid accounts. If your account is on a free plan, the Manage Webhooks section shows a message that webhooks are only available for paid accounts, with a link to your Billing settings to upgrade.


How to turn on signature authentication


  1. Go to Settings → Integrations and scroll to the Manage Webhooks section.
  2. Click Add Webhook to create a new webhook, or click the pencil (edit) icon on an existing webhook to open it.
  3. In the window, turn on the Use webhook signature authentication toggle. Below it you will see "A signing secret will be created when you save. You will see it once."
  4. Finish filling in the webhook (endpoint URL, description, subscribed events) and click Add (or Update) to save.
  5. The Webhook signing secret window opens with your new secret key. Click the key to copy it to your clipboard.
  6. Configure the copied secret on your receiving endpoint so it can verify incoming requests, then click Close.


Important: The secret key is shown only once. After you close the window SuperPath will not show it again: the webhook just says "A signing secret is set." If you lose it, regenerate it (below).


How to regenerate the secret key


Regenerate the key if you have lost it, or if you think someone else may have seen it.


  1. Go to Settings → Integrations and scroll to the Manage Webhooks section.
  2. In the webhook's row, click the Regenerate secret (circular arrows) icon. It only appears on webhooks that use signature authentication.
  3. Read the warning: the current secret stops working straight away, and your endpoint will reject deliveries until it uses the new one.
  4. Click Regenerate secret.
  5. Copy the new key from the window and update it on your receiving endpoint straight away.


How the signature works


When signature authentication is on, SuperPath adds a SuperPath-Signature header to every request it sends to your endpoint. The header has the form <timestamp>,<hmac>: a Unix timestamp and a signature, separated by a comma. The signature is an HMAC-SHA256 hash of the timestamp, computed using your secret key.


To verify a request on your endpoint: split the SuperPath-Signature header on the comma to get the timestamp and the received signature, recompute the HMAC-SHA256 of the timestamp using the same secret key, and compare it with the received signature. If they match, the request came from a sender that knows your secret key. The timestamp can also be used to reject requests that are too old and guard against replay attacks.


For verification code examples and the full details, see the developer guide Webhook Signature Authentication.


Things to keep in mind


  • SuperPath creates the secret key when you save the webhook, and shows it once. Copy it before you close the window.
  • Regenerating replaces the key immediately. Update the new key on your receiving endpoint at the same time, otherwise signature verification will fail and your endpoint will reject deliveries.
  • Turning the toggle off removes the secret key from the webhook, so requests will no longer be signed. Turning it back on creates a new key, shown once when you save.
  • Signature authentication only helps if your endpoint actually verifies the signature. SuperPath signs the request, but your endpoint is responsible for checking it.
  • Deliveries your endpoint rejects show in the Webhook Logs with the status code it returned. See the help article Webhook Logs: Monitor and Troubleshoot Your Webhooks.


FAQs


What header does SuperPath add?
A SuperPath-Signature header in the form <timestamp>,<hmac>, where the HMAC is an HMAC-SHA256 of the timestamp signed with your secret key.


Where do I get the secret key?
It appears in the Webhook signing secret window as soon as you save the webhook with the toggle on. Click the key to copy it, then store it securely on your endpoint.


Can I see the secret key again later?
No. SuperPath never shows a secret key a second time. Use Regenerate secret to get a new one.


What if I regenerate the secret key?
The old key stops working straight away. Update the new key on your endpoint at the same time to avoid failed verifications.


How do I verify the signature in my code?
Recompute the HMAC-SHA256 of the timestamp with your secret key and compare it to the signature in the header. See Webhook Signature Authentication for worked examples.


Who can do this


Only Owners and Admins can add or edit webhooks, their signature settings and their secret keys. Managers, Content Managers, People Managers, Instructors, Employees and Restricted users cannot. The webhooks feature lives under Settings, which is available to Owners and Admins only.

Updated on: 26/10/2026

Was this article helpful?

Share your feedback

Cancel

Thank you!