Event reference
Customer events are delivered to subscribed webhook endpoints in one common envelope. Only the event types listed here are published; each type has its own page.
Event envelope
Every event carries these top-level members. The data.object member holds the changed resource; its content depends on the payload mode (thin carries identifiers, changed_fields and state fields, full carries the management API representation of the resource).
| Member | Type | Required |
|---|---|---|
id |
string |
Yes |
type |
string |
Yes |
schema_version |
integer |
Yes |
environment_id |
string |
Yes |
occurred_at |
string |
Yes |
recorded_at |
string |
Yes |
seq |
integer |
Yes |
data |
object |
Yes |
context |
object |
Yes |
Event types
Users
| Event type | Schema version | Release wave |
|---|---|---|
user.blocked |
1 | GA |
user.created |
1 | GA |
user.deleted |
1 | GA |
user.email_verified |
1 | GA |
user.identity_linked |
1 | GA |
user.identity_unlinked |
1 | GA |
user.locked |
1 | GA |
user.password_changed |
1 | GA |
user.sessions_revoked |
1 | GA |
user.unblocked |
1 | GA |
user.unlocked |
1 | GA |
user.updated |
1 | GA |
Sessions and sign-in
| Event type | Schema version | Release wave |
|---|---|---|
authentication.failed |
1 | GA |
authentication.succeeded |
1 | GA |
session.created |
1 | GA |
session.revoked |
1 | GA |
token.revoked |
1 | GA |
Organizations
| Event type | Schema version | Release wave |
|---|---|---|
organization.created |
1 | GA |
organization.deleted |
1 | GA |
organization.updated |
1 | GA |
organization_domain.verification_failed |
1 | GA |
organization_domain.verified |
1 | GA |
organization_membership.created |
1 | GA |
organization_membership.deleted |
1 | GA |
organization_membership.updated |
1 | GA |
Roles
| Event type | Schema version | Release wave |
|---|---|---|
role.created |
1 | GA |
role.deleted |
1 | GA |
role.updated |
1 | GA |
Invitations
| Event type | Schema version | Release wave |
|---|---|---|
invitation.accepted |
1 | GA |
invitation.created |
1 | GA |
invitation.expired |
1 | GA |
invitation.revoked |
1 | GA |
Connections (SSO)
| Event type | Schema version | Release wave |
|---|---|---|
connection.activated |
1 | GA |
connection.certificate_expiry_warned |
1 | GA |
connection.deactivated |
1 | GA |
connection.deleted |
1 | GA |
Directories (SCIM)
| Event type | Schema version | Release wave |
|---|---|---|
directory.activated |
1 | GA |
directory.deactivated |
1 | GA |
directory.deleted |
1 | GA |
directory_group.created |
1 | GA |
directory_group.deleted |
1 | GA |
directory_group.updated |
1 | GA |
directory_group.user_added |
1 | GA |
directory_group.user_removed |
1 | GA |
directory_user.created |
1 | GA |
directory_user.deleted |
1 | GA |
directory_user.updated |
1 | GA |
Authenticators
| Event type | Schema version | Release wave |
|---|---|---|
authenticator.enrolled |
1 | GA |
authenticator.removed |
1 | GA |
Keys and credentials
| Event type | Schema version | Release wave |
|---|---|---|
api_key.expiry_warned |
1 | GA |
api_key.revoked |
1 | GA |
signing_key.rotated |
1 | GA |
Message delivery
| Event type | Schema version | Release wave |
|---|---|---|
email.delivery_failed |
1 | GA |
sms.delivery_failed |
1 | GA |
Extensibility
| Event type | Schema version | Release wave |
|---|---|---|
hook.circuit_closed |
1 | GA |
hook.circuit_opened |
1 | GA |
Management audit
| Event type | Schema version | Release wave |
|---|---|---|
audit_export.completed |
1 | GA |
audit_export.failed |
1 | GA |