Respond to activity that occurs within WorkOS and third-party providers.
Events represent activity that has occurred within WorkOS or within third-party identity and directory providers. Your app can sync the data via either the events API or webhooks.
All event objects share a similar structure.
| Attribute | Description |
|---|---|
event | A string that distinguishes the event type. |
id | Unique identifier for the event. |
data | Event payload. Payloads match the corresponding API objects. |
created_at | Timestamp of when the event occurred. |
context | An optional object of extra information relevant to the event. |
Events emitted during each step of the authentication flow. Authentication success events are emitted even when additional steps, such as MFA, are required to complete the process.
Events emitted when Single Sign-On connections are activated, deactivated, or deleted. Also emitted when a SAML certificate is renewed for the connection.
Events emitted when directory-related resources are changed. To learn what exactly each of these events represents, see the in-depth Directory Sync events guide.
Events emitted when a user is required to verify their email.
Events emitted when WorkOS feature flags are created, updated, deleted, or their rules are updated.
Events emitted when an AuthKit user is invited to join an organization.
Events emitted when a user requests a Magic Auth code.
Events emitted when WorkOS organizations are created, updated, or deleted.
Events emitted when organization domains are created, updated, deleted, or their verification status changes.
Events emitted when an AuthKit user joins or leaves an organization.
Events emitted when a user requests to reset their password.
Events emitted when roles are created or deleted in the WorkOS dashboard.
Events emitted when AuthKit sessions are created.
Events emitted when AuthKit users are created, updated, or deleted.