Auth providers
WorkOS AuthKit
WorkOS sends signed webhooks, so setup is one endpoint and one pasted secret.
- In Keyring, open Settings > Providers > WorkOS AuthKit and copy the webhook URL (
https://<your-keyring-host>/webhooks/workos). - In the WorkOS Dashboard, switch to the environment your app uses (Staging or Production) and open Webhooks > Create Webhook.
- Set Endpoint URL to the URL from step 1.
- Select
user.created,user.updatedanduser.deleted, then click Create. - On the webhook's page, reveal the Secret, copy it, and paste it into Keyring.
Each environment has its own webhooks and secrets. Repeat these steps for Production when you go live.
What Keyring reads
| Keyring field | WorkOS field |
|---|---|
| external id | data.id |
data.email |
|
| email verified | data.email_verified |
| name | data.name, else first_name + last_name |
| avatar | data.profile_picture_url |
| occurred at | the event's created_at |
Other events, such as organization_membership.created, are accepted with a 200 and ignored.
Verification
WorkOS signs each delivery with WorkOS-Signature: t=<ms>, v1=<hex>, an HMAC-SHA256 of t.body keyed by the secret. Keyring rejects a delivery whose signature does not match or whose timestamp is more than 3 minutes old.