Auth providers
Clerk
Clerk sends webhooks through Svix, signed with the Standard Webhooks scheme. Setup is one endpoint and one pasted secret.
- In Keyring, open Settings > Providers > Clerk and copy the webhook URL (
https://<your-keyring-host>/webhooks/clerk). - In the Clerk Dashboard, pick your application and instance (Development or Production), open Webhooks, and click Add Endpoint.
- Set Endpoint URL to the URL from step 1.
- Under Subscribe to events, select
user.created,user.updatedanduser.deleted, then click Create. - On the endpoint's page, reveal the Signing Secret (it starts with
whsec_), copy it, and paste it into Keyring. - Use the endpoint's Testing tab to send a
user.createdexample. Keyring's Settings page shows the delivery within a few seconds.
Development and Production instances have separate webhooks. Repeat these steps for Production when you go live.
What Keyring reads
| Keyring field | Clerk field |
|---|---|
| external id | data.id |
the entry in data.email_addresses whose id is data.primary_email_address_id |
|
| email verified | that entry's verification.status is verified |
| name | data.first_name + last_name, else data.username |
| avatar | data.image_url |
| occurred at | the event's timestamp |
Other events, such as session.created, and users without an email (phone or web3 only) are accepted with a 200 and ignored.
Verification
Keyring checks the svix-signature header, an HMAC-SHA256 of svix-id.svix-timestamp.body keyed by the secret, and rejects deliveries more than 5 minutes old.