Automatically notify your app any time certain changes are made.
Subscribe your app to changes in Directories by registering incoming webhooks to receive Directory Sync events.
Example use case: Prepare an organization to receive updates of groups and users.
Example use case: Remove the organization’s teams and its users from your application or mark them as deactivated.
Example use case: Remove the organization’s teams and its users from your application or mark them as deleted.
Example use case: Create a new user account and immediately send them a “Getting started” email.
Example use case: Update a user’s profile to reflect changes to attributes such as their name or job title.
Example use case: Flag the user’s account for deactivation or deletion.
Example use case: Populate a new team in your application.
Example use case: Update the team’s profile to reflect changes to attributes such as name.
Example use case: Upgrade the user’s application permissions based on the group they’ve been added to.
Example use case: Downgrade the user’s application permissions based on the group they’ve been removed from.
Example use case: Delete the team from your application.
There is currently no rate limiting on event deliveries.
Webhooks should use HTTPS and expect to receive POST requests with the following headers:
WorkOS sends the header as
WorkOS-Signature, but many web servers will normalize all HTTP request headers to their lowercase variants. In this case, you’ll extract the
See example approaches for implementing a webhook endpoint below.
Set and save the webhook URL in the WorkOS Dashboard, so WorkOS knows where to deliver events.
The Webhook Secret is used to verify webhook requests from WorkOS. Be sure to keep the value secure.
In order to avoid unnecessary retry requests hitting your webhook handler, we recommend using two concurrent processes for handling events: one for receiving the event, and the other for processing it.
On receiving an event, you should respond with an
HTTP 200 OK to signal to WorkOS that the event was successfully delivered. Otherwise, WorkOS will consider the event delivery a failure and retry up to 12 times, with exponential backoff over 3 days.
Before processing the request payload, verify the request was sent by WorkOS and not an unknown party.
WorkOS includes a unique signature in each webhook request that it sends, allowing you to verify the authenticity of the request. In order to verify this signature, you must obtain the secret that is generated for you when you set up your webhook endpoint in the WorkOS dashboard. Ensure that this secret is stored securely on your webhook endpoint server as an environment variable.
The WorkOS SDKs have methods for validating the timestamp and signature of a webhook. Examples using these methods are included below. The parameters are the payload (raw request body), the
WorkOS-Signature header, and the Webhook Secret. There is an optional parameter, tolerance, that sets the time validation for the webhook in seconds. The SDK methods have default values for tolerance, usually 3-5 minutes.
If implementing webhook validation yourself, you’ll need to use the following steps:
First, extract the timestamp and signature from the header. There are two values to parse from the
WorkOS-Signature, delimited by a
issued_timestamp: The number of milliseconds since the epoch time at which the event was issued, prefixed by
signature_hash: The HMAC SHA256 hashed signature for the request, prefixed by
To avoid replay attacks, we suggest validating that the
issued_timestamp does not differ too much from the current time.
Next, construct the expected signature. The expected signature is computed from the concatenation of:
Hash the string using HMAC SHA256, using the Webhook Secret as the key. The expected signature will be the hex digest of the hash. Finally, compare signatures to make sure the webhook request is valid.
Once you’ve determined the event request is validly signed, it’s safe to use the event, i.e. the request body, in your application’s business logic. You do not need to signal to WorkOS whether or not the event was processed successfully.