{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/EventSchema", "title": "EventSchema", "allOf": [ { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" }, "id": { "type": "string", "description": "Unique identifier for the Event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "description": "The type of event that occurred.", "example": "dsync.user.created" }, "data": { "type": "object", "additionalProperties": {}, "description": "The event payload.", "example": { "id": "directory_user_01E1JG7J09H96KYP8HM9B0G5SJ", "directory_id": "directory_01ECAZ4NV9QMV47GW873HDCX74", "organization_id": "org_01EZTR6WYX1A0DSE2CYMGXQ24Y", "state": "active", "email": "veda@foo-corp.com", "emails": [ { "primary": true, "type": "work", "value": "veda@foo-corp.com" } ], "idp_id": "2836", "object": "directory_user", "username": "veda@foo-corp.com", "last_name": "Torp", "first_name": "Veda", "raw_attributes": {}, "custom_attributes": {}, "created_at": "2021-06-25T19:07:33.155Z", "updated_at": "2021-06-25T19:07:33.155Z" } }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "type": "object", "additionalProperties": {}, "description": "Additional context about the event." } }, "required": [ "object", "id", "event", "data", "created_at" ], "description": "An event emitted by WorkOS.", "example": { "object": "event", "id": "event_01EHZNVPK3SFK441A1RGBFSHRT", "event": "dsync.user.created", "data": { "id": "directory_user_01E1JG7J09H96KYP8HM9B0G5SJ", "directory_id": "directory_01ECAZ4NV9QMV47GW873HDCX74", "organization_id": "org_01EZTR6WYX1A0DSE2CYMGXQ24Y", "state": "active", "email": "veda@foo-corp.com", "emails": [ { "primary": true, "type": "work", "value": "veda@foo-corp.com" } ], "idp_id": "2836", "object": "directory_user", "username": "veda@foo-corp.com", "last_name": "Torp", "first_name": "Veda", "raw_attributes": {}, "custom_attributes": {}, "created_at": "2021-06-25T19:07:33.155Z", "updated_at": "2021-06-25T19:07:33.155Z" }, "created_at": "2021-06-25T19:07:33.155Z", "context": {} } }, { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "action.authentication.denied" }, "data": { "type": "object", "properties": { "action_endpoint_id": { "type": "string", "description": "The ID of the action endpoint.", "example": "action_endpoint_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "action_execution_id": { "type": "string", "description": "The ID of the action execution.", "example": "action_execution_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "type": { "type": "string", "description": "The type of action that was denied.", "const": "authentication" }, "verdict": { "type": "string", "description": "The verdict of the action.", "const": "Deny" }, "user_id": { "type": "string", "description": "The ID of the user.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "organization_id": { "type": [ "string", "null" ], "description": "The ID of the organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "email": { "type": "string", "description": "The email address of the user.", "example": "user@example.com" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.1" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" } }, "required": [ "action_endpoint_id", "action_execution_id", "type", "verdict", "user_id", "organization_id", "email", "ip_address", "user_agent" ], "description": "The event payload." }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "action.user_registration.denied" }, "data": { "type": "object", "properties": { "action_endpoint_id": { "type": "string", "description": "The ID of the action endpoint.", "example": "action_endpoint_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "action_execution_id": { "type": "string", "description": "The ID of the action execution.", "example": "action_execution_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "type": { "type": "string", "description": "The type of action that was denied.", "const": "user_registration" }, "verdict": { "type": "string", "description": "The verdict of the action.", "const": "Deny" }, "organization_id": { "type": [ "string", "null" ], "description": "The ID of the organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "email": { "type": "string", "description": "The email address of the user.", "example": "user@example.com" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.1" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" } }, "required": [ "action_endpoint_id", "action_execution_id", "type", "verdict", "organization_id", "email", "ip_address", "user_agent" ], "description": "The event payload." }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "api_key.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the API key object.", "const": "api_key" }, "id": { "type": "string", "description": "Unique identifier of the API key.", "example": "api_key_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "owner": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the API key owner.", "const": "organization" }, "id": { "type": "string", "description": "The unique identifier of the API key owner.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" } }, "required": [ "type", "id" ] }, { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the API key owner.", "const": "user" }, "id": { "type": "string", "description": "The unique identifier of the user who owns the API key.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "organization_id": { "type": "string", "description": "The unique identifier of the organization the API key belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" } }, "required": [ "type", "id", "organization_id" ] } ], "description": "The owner of the API key." }, "name": { "type": "string", "description": "The name of the API key.", "example": "My API Key" }, "obfuscated_value": { "type": "string", "description": "The obfuscated value of the API key.", "example": "sk_test_...1234" }, "last_used_at": { "type": [ "string", "null" ], "description": "The timestamp when the API key was last used.", "example": "2026-01-15T12:00:00.000Z" }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The permissions granted to the API key.", "example": [ "users:read", "users:write" ] }, "created_at": { "type": "string", "description": "The timestamp when the API key was created.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "type": "string", "description": "The timestamp when the API key was last updated.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "owner", "name", "obfuscated_value", "last_used_at", "permissions", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "api_key.revoked" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the API key object.", "const": "api_key" }, "id": { "type": "string", "description": "Unique identifier of the API key.", "example": "api_key_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "owner": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the API key owner.", "const": "organization" }, "id": { "type": "string", "description": "The unique identifier of the API key owner.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" } }, "required": [ "type", "id" ] }, { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the API key owner.", "const": "user" }, "id": { "type": "string", "description": "The unique identifier of the user who owns the API key.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "organization_id": { "type": "string", "description": "The unique identifier of the organization the API key belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" } }, "required": [ "type", "id", "organization_id" ] } ], "description": "The owner of the API key." }, "name": { "type": "string", "description": "The name of the API key.", "example": "My API Key" }, "obfuscated_value": { "type": "string", "description": "The obfuscated value of the API key.", "example": "sk_test_...1234" }, "last_used_at": { "type": [ "string", "null" ], "description": "The timestamp when the API key was last used.", "example": "2026-01-15T12:00:00.000Z" }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The permissions granted to the API key.", "example": [ "users:read", "users:write" ] }, "created_at": { "type": "string", "description": "The timestamp when the API key was created.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "type": "string", "description": "The timestamp when the API key was last updated.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "owner", "name", "obfuscated_value", "last_used_at", "permissions", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.email_verification_failed" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "email_verification" }, "status": { "type": "string", "const": "failed" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": [ "string", "null" ], "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": [ "string", "null" ], "description": "The email address of the user.", "example": "user@example.com" }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "The error code.", "example": "mfa_challenge_failed" }, "message": { "type": "string", "description": "A human-readable error message.", "example": "The MFA challenge has failed." } }, "required": [ "code", "message" ], "description": "Details about the authentication error." } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email", "error" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.email_verification_succeeded" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "email_verification" }, "status": { "type": "string", "const": "succeeded" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": "string", "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the user.", "example": "user@example.com" } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.magic_auth_failed" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "magic_auth" }, "status": { "type": "string", "const": "failed" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": [ "string", "null" ], "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": [ "string", "null" ], "description": "The email address of the user.", "example": "user@example.com" }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "The error code.", "example": "mfa_challenge_failed" }, "message": { "type": "string", "description": "A human-readable error message.", "example": "The MFA challenge has failed." } }, "required": [ "code", "message" ], "description": "Details about the authentication error." } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email", "error" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.magic_auth_succeeded" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "magic_auth" }, "status": { "type": "string", "const": "succeeded" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": "string", "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the user.", "example": "user@example.com" } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.mfa_failed" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "mfa" }, "status": { "type": "string", "const": "failed" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": [ "string", "null" ], "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": [ "string", "null" ], "description": "The email address of the user.", "example": "user@example.com" }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "The error code.", "example": "mfa_challenge_failed" }, "message": { "type": "string", "description": "A human-readable error message.", "example": "The MFA challenge has failed." } }, "required": [ "code", "message" ], "description": "Details about the authentication error." } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email", "error" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.mfa_succeeded" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "mfa" }, "status": { "type": "string", "const": "succeeded" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": "string", "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the user.", "example": "user@example.com" } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.oauth_failed" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "oauth" }, "status": { "type": "string", "const": "failed" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": [ "string", "null" ], "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": [ "string", "null" ], "description": "The email address of the user.", "example": "user@example.com" }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "The error code.", "example": "mfa_challenge_failed" }, "message": { "type": "string", "description": "A human-readable error message.", "example": "The MFA challenge has failed." } }, "required": [ "code", "message" ], "description": "Details about the authentication error." } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email", "error" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.oauth_succeeded" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "oauth" }, "status": { "type": "string", "const": "succeeded" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": [ "string", "null" ], "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the user.", "example": "user@example.com" } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.passkey_failed" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "passkey" }, "status": { "type": "string", "const": "failed" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": [ "string", "null" ], "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": [ "string", "null" ], "description": "The email address of the user.", "example": "user@example.com" }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "The error code.", "example": "mfa_challenge_failed" }, "message": { "type": "string", "description": "A human-readable error message.", "example": "The MFA challenge has failed." } }, "required": [ "code", "message" ], "description": "Details about the authentication error." } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email", "error" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.passkey_succeeded" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "passkey" }, "status": { "type": "string", "const": "succeeded" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": "string", "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the user.", "example": "user@example.com" } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.password_failed" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "password" }, "status": { "type": "string", "const": "failed" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": [ "string", "null" ], "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": [ "string", "null" ], "description": "The email address of the user.", "example": "user@example.com" }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "The error code.", "example": "mfa_challenge_failed" }, "message": { "type": "string", "description": "A human-readable error message.", "example": "The MFA challenge has failed." } }, "required": [ "code", "message" ], "description": "Details about the authentication error." } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email", "error" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.password_succeeded" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "password" }, "status": { "type": "string", "const": "succeeded" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": "string", "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the user.", "example": "user@example.com" } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.radar_risk_detected" }, "data": { "type": "object", "properties": { "auth_method": { "type": "string", "description": "The authentication method used.", "example": "password" }, "action": { "type": "string", "enum": [ "signup", "login" ] }, "control": { "type": [ "string", "null" ], "description": "The control action taken for the detected risk.", "example": "block" }, "blocklist_type": { "type": [ "string", "null" ], "description": "The type of blocklist that triggered the risk detection.", "example": "ip" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": "string", "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the user.", "example": "user@example.com" } }, "required": [ "auth_method", "action", "control", "blocklist_type", "ip_address", "user_agent", "user_id", "email" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.sso_failed" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "sso" }, "status": { "type": "string", "const": "failed" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": [ "string", "null" ], "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": [ "string", "null" ], "description": "The email address of the user.", "example": "user@example.com" }, "sso": { "type": "object", "properties": { "organization_id": { "type": [ "string", "null" ], "description": "The ID of the organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "connection_id": { "type": [ "string", "null" ], "description": "The ID of the SSO connection.", "example": "conn_01E4ZCR3C56J083X43JQXF3JK5" }, "session_id": { "type": [ "string", "null" ], "description": "The ID of the SSO session.", "example": "sess_01E4ZCR3C56J083X43JQXF3JK5" } }, "required": [ "organization_id", "connection_id", "session_id" ], "description": "SSO connection details." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "The error code.", "example": "mfa_challenge_failed" }, "message": { "type": "string", "description": "A human-readable error message.", "example": "The MFA challenge has failed." } }, "required": [ "code", "message" ], "description": "Details about the authentication error." } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email", "sso", "error" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.sso_started" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "sso" }, "status": { "type": "string", "const": "started" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": [ "string", "null" ], "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": [ "string", "null" ], "description": "The email address of the user.", "example": "user@example.com" }, "sso": { "type": "object", "properties": { "organization_id": { "type": [ "string", "null" ], "description": "The ID of the organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "connection_id": { "type": [ "string", "null" ], "description": "The ID of the SSO connection.", "example": "conn_01E4ZCR3C56J083X43JQXF3JK5" }, "session_id": { "type": [ "string", "null" ], "description": "The ID of the SSO session.", "example": "sess_01E4ZCR3C56J083X43JQXF3JK5" } }, "required": [ "organization_id", "connection_id", "session_id" ], "description": "SSO connection details." } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email", "sso" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.sso_succeeded" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "sso" }, "status": { "type": "string", "const": "succeeded" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": [ "string", "null" ], "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the user.", "example": "user@example.com" }, "sso": { "type": "object", "properties": { "organization_id": { "type": [ "string", "null" ], "description": "The ID of the organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "connection_id": { "type": [ "string", "null" ], "description": "The ID of the SSO connection.", "example": "conn_01E4ZCR3C56J083X43JQXF3JK5" }, "session_id": { "type": [ "string", "null" ], "description": "The ID of the SSO session.", "example": "sess_01E4ZCR3C56J083X43JQXF3JK5" } }, "required": [ "organization_id", "connection_id", "session_id" ], "description": "SSO connection details." } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email", "sso" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "authentication.sso_timed_out" }, "data": { "type": "object", "properties": { "type": { "type": "string", "const": "sso" }, "status": { "type": "string", "const": "timed_out" }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address of the request.", "example": "203.0.113.42" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent of the request.", "example": "Mozilla/5.0" }, "user_id": { "type": [ "string", "null" ], "description": "The ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": [ "string", "null" ], "description": "The email address of the user.", "example": "user@example.com" }, "sso": { "type": "object", "properties": { "organization_id": { "type": [ "string", "null" ], "description": "The ID of the organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "connection_id": { "type": [ "string", "null" ], "description": "The ID of the SSO connection.", "example": "conn_01E4ZCR3C56J083X43JQXF3JK5" }, "session_id": { "type": [ "string", "null" ], "description": "The ID of the SSO session.", "example": "sess_01E4ZCR3C56J083X43JQXF3JK5" } }, "required": [ "organization_id", "connection_id", "session_id" ], "description": "SSO connection details." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "The error code.", "example": "mfa_challenge_failed" }, "message": { "type": "string", "description": "A human-readable error message.", "example": "The MFA challenge has failed." } }, "required": [ "code", "message" ], "description": "Details about the authentication error." } }, "required": [ "type", "status", "ip_address", "user_agent", "user_id", "email", "sso", "error" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "connection.activated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the connection object.", "const": "connection" }, "id": { "type": "string", "description": "Unique identifier of the connection.", "example": "conn_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "state": { "type": "string", "enum": [ "draft", "active", "validating", "inactive", "deleting" ], "description": "The current state of the connection.", "example": "active" }, "name": { "type": "string", "description": "The name of the connection.", "example": "Acme SSO" }, "connection_type": { "type": "string", "enum": [ "ADFSSAML", "AdpOidc", "AppleOAuth", "Auth0Migration", "Auth0SAML", "AzureSAML", "BitbucketOAuth", "CasSAML", "ClassLinkSAML", "CleverOIDC", "CloudflareSAML", "CyberArkSAML", "DiscordOAuth", "DuoSAML", "EntraIdOIDC", "GenericOIDC", "GenericSAML", "GitHubOAuth", "GitLabOAuth", "GoogleOAuth", "GoogleOIDC", "GoogleSAML", "IntuitOAuth", "JumpCloudSAML", "KeycloakSAML", "LastPassSAML", "LinkedInOAuth", "LoginGovOidc", "MagicLink", "MicrosoftOAuth", "MiniOrangeSAML", "NetIqSAML", "OktaOIDC", "OktaSAML", "OneLoginSAML", "OracleSAML", "PingFederateSAML", "PingOneSAML", "RipplingSAML", "SalesforceSAML", "ShibbolethGenericSAML", "ShibbolethSAML", "SimpleSamlPhpSAML", "SalesforceOAuth", "SlackOAuth", "TestIdp", "VercelMarketplaceOAuth", "VercelOAuth", "VMwareSAML", "XeroOAuth" ], "description": "The type of the connection.", "example": "OktaSAML" }, "organization_id": { "type": "string", "description": "The ID of the organization the connection belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "external_key": { "type": "string", "description": "The external key of the connection.", "example": "ext_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "status": { "type": "string", "enum": [ "linked", "unlinked" ], "description": "Deprecated. Use state instead.", "example": "linked" }, "domains": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the connection domain object.", "const": "connection_domain" }, "id": { "type": "string", "description": "Unique identifier of the connection domain.", "example": "conn_domain_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "domain": { "type": "string", "description": "The domain value.", "example": "acme.com" } }, "required": [ "object", "id", "domain" ] }, "description": "The domains associated with the connection." } }, "required": [ "object", "id", "state", "name", "connection_type", "created_at", "updated_at", "external_key", "status", "domains" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "connection.deactivated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the connection object.", "const": "connection" }, "id": { "type": "string", "description": "Unique identifier of the connection.", "example": "conn_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "state": { "type": "string", "enum": [ "draft", "active", "validating", "inactive", "deleting" ], "description": "The current state of the connection.", "example": "active" }, "name": { "type": "string", "description": "The name of the connection.", "example": "Acme SSO" }, "connection_type": { "type": "string", "enum": [ "ADFSSAML", "AdpOidc", "AppleOAuth", "Auth0Migration", "Auth0SAML", "AzureSAML", "BitbucketOAuth", "CasSAML", "ClassLinkSAML", "CleverOIDC", "CloudflareSAML", "CyberArkSAML", "DiscordOAuth", "DuoSAML", "EntraIdOIDC", "GenericOIDC", "GenericSAML", "GitHubOAuth", "GitLabOAuth", "GoogleOAuth", "GoogleOIDC", "GoogleSAML", "IntuitOAuth", "JumpCloudSAML", "KeycloakSAML", "LastPassSAML", "LinkedInOAuth", "LoginGovOidc", "MagicLink", "MicrosoftOAuth", "MiniOrangeSAML", "NetIqSAML", "OktaOIDC", "OktaSAML", "OneLoginSAML", "OracleSAML", "PingFederateSAML", "PingOneSAML", "RipplingSAML", "SalesforceSAML", "ShibbolethGenericSAML", "ShibbolethSAML", "SimpleSamlPhpSAML", "SalesforceOAuth", "SlackOAuth", "TestIdp", "VercelMarketplaceOAuth", "VercelOAuth", "VMwareSAML", "XeroOAuth" ], "description": "The type of the connection.", "example": "OktaSAML" }, "organization_id": { "type": "string", "description": "The ID of the organization the connection belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "external_key": { "type": "string", "description": "The external key of the connection.", "example": "ext_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "status": { "type": "string", "enum": [ "linked", "unlinked" ], "description": "Deprecated. Use state instead.", "example": "linked" }, "domains": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the connection domain object.", "const": "connection_domain" }, "id": { "type": "string", "description": "Unique identifier of the connection domain.", "example": "conn_domain_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "domain": { "type": "string", "description": "The domain value.", "example": "acme.com" } }, "required": [ "object", "id", "domain" ] }, "description": "The domains associated with the connection." } }, "required": [ "object", "id", "state", "name", "connection_type", "created_at", "updated_at", "external_key", "status", "domains" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "connection.deleted" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the connection object.", "const": "connection" }, "id": { "type": "string", "description": "Unique identifier of the connection.", "example": "conn_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "state": { "type": "string", "enum": [ "draft", "active", "validating", "inactive", "deleting" ], "description": "The current state of the connection.", "example": "active" }, "name": { "type": "string", "description": "The name of the connection.", "example": "Acme SSO" }, "connection_type": { "type": "string", "enum": [ "ADFSSAML", "AdpOidc", "AppleOAuth", "Auth0Migration", "Auth0SAML", "AzureSAML", "BitbucketOAuth", "CasSAML", "ClassLinkSAML", "CleverOIDC", "CloudflareSAML", "CyberArkSAML", "DiscordOAuth", "DuoSAML", "EntraIdOIDC", "GenericOIDC", "GenericSAML", "GitHubOAuth", "GitLabOAuth", "GoogleOAuth", "GoogleOIDC", "GoogleSAML", "IntuitOAuth", "JumpCloudSAML", "KeycloakSAML", "LastPassSAML", "LinkedInOAuth", "LoginGovOidc", "MagicLink", "MicrosoftOAuth", "MiniOrangeSAML", "NetIqSAML", "OktaOIDC", "OktaSAML", "OneLoginSAML", "OracleSAML", "PingFederateSAML", "PingOneSAML", "RipplingSAML", "SalesforceSAML", "ShibbolethGenericSAML", "ShibbolethSAML", "SimpleSamlPhpSAML", "SalesforceOAuth", "SlackOAuth", "TestIdp", "VercelMarketplaceOAuth", "VercelOAuth", "VMwareSAML", "XeroOAuth" ], "description": "The type of the connection.", "example": "OktaSAML" }, "organization_id": { "type": "string", "description": "The ID of the organization the connection belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "state", "name", "connection_type", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "connection.saml_certificate_renewal_required" }, "data": { "type": "object", "properties": { "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the connection.", "example": "conn_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "organization_id": { "type": "string", "description": "The ID of the organization the connection belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" } }, "required": [ "id" ], "description": "The connection with the expiring certificate." }, "certificate": { "type": "object", "properties": { "certificate_type": { "type": "string", "enum": [ "ResponseSigning", "RequestSigning", "ResponseEncryption" ], "description": "The type of the SAML certificate.", "example": "ResponseSigning" }, "expiry_date": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "is_expired": { "type": "boolean", "description": "Whether the certificate has already expired.", "example": false } }, "required": [ "certificate_type", "expiry_date", "is_expired" ], "description": "The SAML certificate details." }, "days_until_expiry": { "type": "integer", "description": "The number of days until the certificate expires.", "example": 30 } }, "required": [ "connection", "certificate", "days_until_expiry" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "connection.saml_certificate_renewed" }, "data": { "type": "object", "properties": { "connection": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the connection.", "example": "conn_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "organization_id": { "type": "string", "description": "The ID of the organization the connection belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" } }, "required": [ "id" ], "description": "The connection with the renewed certificate." }, "certificate": { "type": "object", "properties": { "certificate_type": { "type": "string", "enum": [ "ResponseSigning", "RequestSigning", "ResponseEncryption" ], "description": "The type of the SAML certificate.", "example": "ResponseSigning" }, "expiry_date": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "certificate_type", "expiry_date" ], "description": "The renewed SAML certificate details." }, "renewed_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "connection", "certificate", "renewed_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "dsync.activated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the directory object.", "const": "directory" }, "id": { "type": "string", "description": "Unique identifier of the directory.", "example": "directory_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "organization_id": { "type": "string", "description": "The ID of the organization the directory belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "type": { "type": "string", "enum": [ "azure scim v2.0", "bamboohr", "breathe hr", "cezanne hr", "cyberark scim v2.0", "fourth hr", "generic scim v2.0", "gsuite directory", "gusto", "hibob", "jump cloud scim v2.0", "okta scim v2.0", "onelogin scim v2.0", "people hr", "personio", "pingfederate scim v2.0", "rippling scim v2.0", "rippling", "sailpoint scim v2.0", "s3", "sftp", "sftp workday", "workday" ], "description": "The type of the directory.", "example": "okta scim v2.0" }, "state": { "type": "string", "enum": [ "active", "validating", "invalid_credentials", "inactive", "deleting" ], "description": "The current state of the directory.", "example": "active" }, "name": { "type": "string", "description": "The name of the directory.", "example": "Acme Directory" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "external_key": { "type": "string", "description": "The external key of the directory.", "example": "ext_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "domains": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization domain object.", "const": "organization_domain" }, "id": { "type": "string", "description": "Unique identifier of the organization domain.", "example": "org_domain_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "domain": { "type": "string", "description": "The domain value.", "example": "acme.com" } }, "required": [ "object", "id", "domain" ] }, "description": "The domains associated with the directory." } }, "required": [ "object", "id", "type", "state", "name", "created_at", "updated_at", "external_key", "domains" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "dsync.deactivated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the directory object.", "const": "directory" }, "id": { "type": "string", "description": "Unique identifier of the directory.", "example": "directory_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "organization_id": { "type": "string", "description": "The ID of the organization the directory belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "type": { "type": "string", "enum": [ "azure scim v2.0", "bamboohr", "breathe hr", "cezanne hr", "cyberark scim v2.0", "fourth hr", "generic scim v2.0", "gsuite directory", "gusto", "hibob", "jump cloud scim v2.0", "okta scim v2.0", "onelogin scim v2.0", "people hr", "personio", "pingfederate scim v2.0", "rippling scim v2.0", "rippling", "sailpoint scim v2.0", "s3", "sftp", "sftp workday", "workday" ], "description": "The type of the directory.", "example": "okta scim v2.0" }, "state": { "type": "string", "enum": [ "active", "validating", "invalid_credentials", "inactive", "deleting" ], "description": "The current state of the directory.", "example": "active" }, "name": { "type": "string", "description": "The name of the directory.", "example": "Acme Directory" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "external_key": { "type": "string", "description": "The external key of the directory.", "example": "ext_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "domains": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization domain object.", "const": "organization_domain" }, "id": { "type": "string", "description": "Unique identifier of the organization domain.", "example": "org_domain_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "domain": { "type": "string", "description": "The domain value.", "example": "acme.com" } }, "required": [ "object", "id", "domain" ] }, "description": "The domains associated with the directory." } }, "required": [ "object", "id", "type", "state", "name", "created_at", "updated_at", "external_key", "domains" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "dsync.deleted" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the directory object.", "const": "directory" }, "id": { "type": "string", "description": "Unique identifier of the directory.", "example": "directory_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "organization_id": { "type": "string", "description": "The ID of the organization the directory belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "type": { "type": "string", "enum": [ "azure scim v2.0", "bamboohr", "breathe hr", "cezanne hr", "cyberark scim v2.0", "fourth hr", "generic scim v2.0", "gsuite directory", "gusto", "hibob", "jump cloud scim v2.0", "okta scim v2.0", "onelogin scim v2.0", "people hr", "personio", "pingfederate scim v2.0", "rippling scim v2.0", "rippling", "sailpoint scim v2.0", "s3", "sftp", "sftp workday", "workday" ], "description": "The type of the directory.", "example": "okta scim v2.0" }, "state": { "type": "string", "enum": [ "active", "validating", "invalid_credentials", "inactive", "deleting" ], "description": "The current state of the directory.", "example": "active" }, "name": { "type": "string", "description": "The name of the directory.", "example": "Acme Directory" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "type", "state", "name", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "dsync.group.created" }, "data": { "$ref": "#/components/schemas/DirectoryGroup", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "dsync.group.deleted" }, "data": { "$ref": "#/components/schemas/DirectoryGroup", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "dsync.group.updated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the Directory Group object.", "const": "directory_group" }, "id": { "type": "string", "description": "Unique identifier for the Directory Group.", "example": "directory_group_01E1JJS84MFPPQ3G655FHTKX6Z" }, "idp_id": { "type": "string", "description": "Unique identifier for the group, assigned by the Directory Provider. Different Directory Providers use different ID formats.", "example": "02grqrue4294w24" }, "directory_id": { "type": "string", "description": "The identifier of the Directory the Directory Group belongs to.", "example": "directory_01ECAZ4NV9QMV47GW873HDCX74" }, "organization_id": { "type": "string", "description": "The identifier for the Organization in which the Directory resides.", "example": "org_01EZTR6WYX1A0DSE2CYMGXQ24Y" }, "name": { "type": "string", "description": "The name of the Directory Group.", "example": "Developers" }, "raw_attributes": { "type": "object", "additionalProperties": {}, "description": "The raw attributes received from the directory provider." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "previous_attributes": { "type": "object", "additionalProperties": {} } }, "required": [ "object", "id", "idp_id", "directory_id", "organization_id", "name", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "dsync.group.user_added" }, "data": { "type": "object", "properties": { "directory_id": { "type": "string", "description": "The ID of the directory.", "example": "directory_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "user": { "$ref": "#/components/schemas/DirectoryUser", "description": "The directory user added to the group." }, "group": { "$ref": "#/components/schemas/DirectoryGroup", "description": "The directory group the user was added to." } }, "required": [ "directory_id", "user", "group" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "dsync.user.created" }, "data": { "$ref": "#/components/schemas/DirectoryUser", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "dsync.user.deleted" }, "data": { "$ref": "#/components/schemas/DirectoryUser", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "dsync.group.user_removed" }, "data": { "type": "object", "properties": { "directory_id": { "type": "string", "description": "The ID of the directory.", "example": "directory_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "user": { "$ref": "#/components/schemas/DirectoryUser", "description": "The directory user removed from the group." }, "group": { "$ref": "#/components/schemas/DirectoryGroup", "description": "The directory group the user was removed from." } }, "required": [ "directory_id", "user", "group" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "dsync.user.updated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the Directory User object.", "const": "directory_user" }, "id": { "type": "string", "description": "Unique identifier for the Directory User.", "example": "directory_user_01E1JG7J09H96KYP8HM9B0G5SJ" }, "directory_id": { "type": "string", "description": "The identifier of the Directory the Directory User belongs to.", "example": "directory_01ECAZ4NV9QMV47GW873HDCX74" }, "organization_id": { "type": "string", "description": "The identifier for the Organization in which the Directory resides.", "example": "org_01EZTR6WYX1A0DSE2CYMGXQ24Y" }, "idp_id": { "type": "string", "description": "Unique identifier for the user, assigned by the Directory Provider. Different Directory Providers use different ID formats.", "example": "2836" }, "email": { "type": [ "string", "null" ], "description": "The email address of the user.", "example": "marcelina.davis@example.com" }, "first_name": { "type": [ "string", "null" ], "description": "The first name of the user.", "example": "Marcelina" }, "last_name": { "type": [ "string", "null" ], "description": "The last name of the user.", "example": "Davis" }, "name": { "type": [ "string", "null" ], "description": "The full name of the user.", "example": "Marcelina Davis" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "primary": { "type": "boolean", "description": "Whether this is the primary email address.", "example": true }, "type": { "type": "string", "description": "The type of email address.", "example": "work" }, "value": { "type": [ "string", "null" ], "description": "The email address value.", "example": "marcelina.davis@example.com" } } }, "description": "A list of email addresses for the user.", "deprecated": true }, "job_title": { "type": [ "string", "null" ], "description": "The job title of the user.", "example": "Software Engineer", "deprecated": true }, "username": { "type": [ "string", "null" ], "description": "The username of the user.", "example": "mdavis", "deprecated": true }, "state": { "type": "string", "enum": [ "active", "suspended", "inactive" ], "description": "The state of the user.", "example": "active" }, "raw_attributes": { "type": "object", "additionalProperties": {}, "description": "The raw attributes received from the directory provider.", "deprecated": true }, "custom_attributes": { "type": "object", "additionalProperties": {}, "description": "An object containing the custom attribute mapping for the Directory Provider.", "example": { "department": "Engineering", "job_title": "Software Engineer" } }, "role": { "$ref": "#/components/schemas/SlimRole" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/SlimRole" }, "description": "All roles assigned to the user." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "previous_attributes": { "type": "object", "additionalProperties": {} } }, "required": [ "object", "id", "directory_id", "organization_id", "idp_id", "email", "state", "raw_attributes", "custom_attributes", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "email_verification.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the email verification object.", "const": "email_verification" }, "id": { "type": "string", "description": "The unique ID of the email verification code.", "example": "email_verification_01E4ZCR3C56J083X43JQXF3JK5" }, "user_id": { "type": "string", "description": "The unique ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the user.", "example": "marcelina.davis@example.com" }, "expires_at": { "format": "date-time", "type": "string", "description": "The timestamp when the email verification code expires.", "example": "2026-01-15T12:00:00.000Z" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "user_id", "email", "expires_at", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "flag.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "const": "feature_flag" }, "id": { "type": "string", "description": "Unique identifier of the Feature Flag.", "example": "flag_01EHZNVPK3SFK441A1RGBFSHRT" }, "environment_id": { "type": "string", "description": "The ID of the environment the Feature Flag belongs to.", "example": "environment_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "slug": { "type": "string", "description": "A unique key to reference the Feature Flag.", "example": "advanced-analytics" }, "name": { "type": "string", "description": "A descriptive name for the Feature Flag.", "example": "Advanced Analytics" }, "description": { "type": [ "string", "null" ], "description": "A description for the Feature Flag.", "example": "Enable advanced analytics dashboard feature" }, "owner": { "description": "The owner of the Feature Flag.", "oneOf": [ { "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the flag owner.", "example": "jane@example.com" }, "first_name": { "type": [ "string", "null" ], "description": "The first name of the flag owner.", "example": "Jane" }, "last_name": { "type": [ "string", "null" ], "description": "The last name of the flag owner.", "example": "Doe" } }, "required": [ "email", "first_name", "last_name" ] }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Labels assigned to the Feature Flag for categorizing and filtering.", "example": [ "reports" ] }, "enabled": { "type": "boolean", "description": "Specifies whether the Feature Flag is active for the current environment.", "example": true }, "default_value": { "type": "boolean", "description": "The value returned for users and organizations who don't match any configured targeting rules.", "example": false }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "environment_id", "slug", "name", "description", "owner", "tags", "enabled", "default_value", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "type": "object", "properties": { "client_id": { "type": "string", "description": "The client ID associated with the flag event.", "example": "client_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "source": { "type": "string", "enum": [ "api", "dashboard", "admin_portal", "system" ], "description": "The source of the actor that performed the action." }, "name": { "type": [ "string", "null" ], "description": "The name of the actor.", "example": "Jane Doe" } }, "required": [ "id", "source", "name" ], "description": "The actor who performed the action." } }, "required": [ "client_id", "actor" ], "description": "Additional context about the event." }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "context", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "flag.deleted" }, "data": { "type": "object", "properties": { "object": { "type": "string", "const": "feature_flag" }, "id": { "type": "string", "description": "Unique identifier of the Feature Flag.", "example": "flag_01EHZNVPK3SFK441A1RGBFSHRT" }, "environment_id": { "type": "string", "description": "The ID of the environment the Feature Flag belongs to.", "example": "environment_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "slug": { "type": "string", "description": "A unique key to reference the Feature Flag.", "example": "advanced-analytics" }, "name": { "type": "string", "description": "A descriptive name for the Feature Flag.", "example": "Advanced Analytics" }, "description": { "type": [ "string", "null" ], "description": "A description for the Feature Flag.", "example": "Enable advanced analytics dashboard feature" }, "owner": { "description": "The owner of the Feature Flag.", "oneOf": [ { "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the flag owner.", "example": "jane@example.com" }, "first_name": { "type": [ "string", "null" ], "description": "The first name of the flag owner.", "example": "Jane" }, "last_name": { "type": [ "string", "null" ], "description": "The last name of the flag owner.", "example": "Doe" } }, "required": [ "email", "first_name", "last_name" ] }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Labels assigned to the Feature Flag for categorizing and filtering.", "example": [ "reports" ] }, "enabled": { "type": "boolean", "description": "Specifies whether the Feature Flag is active for the current environment.", "example": true }, "default_value": { "type": "boolean", "description": "The value returned for users and organizations who don't match any configured targeting rules.", "example": false }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "environment_id", "slug", "name", "description", "owner", "tags", "enabled", "default_value", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "type": "object", "properties": { "client_id": { "type": "string", "description": "The client ID associated with the flag event.", "example": "client_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "source": { "type": "string", "enum": [ "api", "dashboard", "admin_portal", "system" ], "description": "The source of the actor that performed the action." }, "name": { "type": [ "string", "null" ], "description": "The name of the actor.", "example": "Jane Doe" } }, "required": [ "id", "source", "name" ], "description": "The actor who performed the action." } }, "required": [ "client_id", "actor" ], "description": "Additional context about the event." }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "context", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "flag.rule_updated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "const": "feature_flag" }, "id": { "type": "string", "description": "Unique identifier of the Feature Flag.", "example": "flag_01EHZNVPK3SFK441A1RGBFSHRT" }, "environment_id": { "type": "string", "description": "The ID of the environment the Feature Flag belongs to.", "example": "environment_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "slug": { "type": "string", "description": "A unique key to reference the Feature Flag.", "example": "advanced-analytics" }, "name": { "type": "string", "description": "A descriptive name for the Feature Flag.", "example": "Advanced Analytics" }, "description": { "type": [ "string", "null" ], "description": "A description for the Feature Flag.", "example": "Enable advanced analytics dashboard feature" }, "owner": { "description": "The owner of the Feature Flag.", "oneOf": [ { "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the flag owner.", "example": "jane@example.com" }, "first_name": { "type": [ "string", "null" ], "description": "The first name of the flag owner.", "example": "Jane" }, "last_name": { "type": [ "string", "null" ], "description": "The last name of the flag owner.", "example": "Doe" } }, "required": [ "email", "first_name", "last_name" ] }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Labels assigned to the Feature Flag for categorizing and filtering.", "example": [ "reports" ] }, "enabled": { "type": "boolean", "description": "Specifies whether the Feature Flag is active for the current environment.", "example": true }, "default_value": { "type": "boolean", "description": "The value returned for users and organizations who don't match any configured targeting rules.", "example": false }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "environment_id", "slug", "name", "description", "owner", "tags", "enabled", "default_value", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "type": "object", "properties": { "client_id": { "type": "string", "description": "The client ID associated with the flag event.", "example": "client_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "source": { "type": "string", "enum": [ "api", "dashboard", "admin_portal", "system" ] }, "name": { "type": [ "string", "null" ], "description": "The name of the actor.", "example": "Jane Doe" } }, "required": [ "id", "source", "name" ], "description": "The actor who performed the action." }, "access_type": { "type": "string", "enum": [ "none", "some", "all" ], "description": "The access type of the flag rule." }, "configured_targets": { "type": "object", "properties": { "organizations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "name": { "type": "string", "description": "The name of the organization.", "example": "Acme Corp" } }, "required": [ "id", "name" ] }, "description": "The organizations targeted by the flag rule." }, "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the user.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "email": { "type": "string", "description": "The email of the user.", "example": "user@example.com" } }, "required": [ "id", "email" ] }, "description": "The users targeted by the flag rule." } }, "required": [ "organizations", "users" ], "description": "The configured targets for the flag rule." }, "previous_attributes": { "type": "object", "properties": { "data": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether the flag was previously enabled.", "example": true }, "default_value": { "type": "boolean", "description": "The previous default value of the flag.", "example": false } }, "description": "The previous data attributes of the flag." }, "context": { "type": "object", "properties": { "access_type": { "type": "string", "enum": [ "none", "some", "all" ], "description": "The previous access type of the flag rule." }, "configured_targets": { "type": "object", "properties": { "organizations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "name": { "type": "string", "description": "The name of the organization.", "example": "Acme Corp" } }, "required": [ "id", "name" ] }, "description": "The organizations targeted by the flag rule." }, "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the user.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "email": { "type": "string", "description": "The email of the user.", "example": "user@example.com" } }, "required": [ "id", "email" ] }, "description": "The users targeted by the flag rule." } }, "required": [ "organizations", "users" ], "description": "The previous configured targets for the flag rule." } }, "description": "The previous context attributes of the flag rule." } }, "description": "Attributes that changed from their previous values." } }, "required": [ "client_id", "actor", "access_type", "configured_targets", "previous_attributes" ], "description": "Additional context about the event." }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "context", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "flag.updated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "const": "feature_flag" }, "id": { "type": "string", "description": "Unique identifier of the Feature Flag.", "example": "flag_01EHZNVPK3SFK441A1RGBFSHRT" }, "environment_id": { "type": "string", "description": "The ID of the environment the Feature Flag belongs to.", "example": "environment_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "slug": { "type": "string", "description": "A unique key to reference the Feature Flag.", "example": "advanced-analytics" }, "name": { "type": "string", "description": "A descriptive name for the Feature Flag.", "example": "Advanced Analytics" }, "description": { "type": [ "string", "null" ], "description": "A description for the Feature Flag.", "example": "Enable advanced analytics dashboard feature" }, "owner": { "description": "The owner of the Feature Flag.", "oneOf": [ { "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the flag owner.", "example": "jane@example.com" }, "first_name": { "type": [ "string", "null" ], "description": "The first name of the flag owner.", "example": "Jane" }, "last_name": { "type": [ "string", "null" ], "description": "The last name of the flag owner.", "example": "Doe" } }, "required": [ "email", "first_name", "last_name" ] }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Labels assigned to the Feature Flag for categorizing and filtering.", "example": [ "reports" ] }, "enabled": { "type": "boolean", "description": "Specifies whether the Feature Flag is active for the current environment.", "example": true }, "default_value": { "type": "boolean", "description": "The value returned for users and organizations who don't match any configured targeting rules.", "example": false }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "environment_id", "slug", "name", "description", "owner", "tags", "enabled", "default_value", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "type": "object", "properties": { "client_id": { "type": "string", "description": "The client ID associated with the flag event.", "example": "client_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "source": { "type": "string", "enum": [ "api", "dashboard", "admin_portal", "system" ], "description": "The source of the actor that performed the action." }, "name": { "type": [ "string", "null" ], "description": "The name of the actor.", "example": "Jane Doe" } }, "required": [ "id", "source", "name" ], "description": "The actor who performed the action." }, "previous_attributes": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "The previous name of the flag.", "example": "My Feature Flag" }, "description": { "type": [ "string", "null" ], "description": "The previous description of the flag.", "example": "Enables the new feature." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "The previous tags of the flag.", "example": [ "beta", "release" ] }, "enabled": { "type": "boolean", "description": "Whether the flag was previously enabled.", "example": true }, "default_value": { "type": "boolean", "description": "The previous default value of the flag.", "example": false } }, "description": "The previous data attributes of the flag." } }, "description": "Attributes that changed from their previous values." } }, "required": [ "client_id", "actor" ], "description": "Additional context about the event." }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "context", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "group.created" }, "data": { "$ref": "#/components/schemas/Group", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "group.deleted" }, "data": { "$ref": "#/components/schemas/Group", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "group.member_added" }, "data": { "type": "object", "properties": { "group_id": { "type": "string", "description": "The ID of the Group.", "example": "group_01HXYZ123456789ABCDEFGHIJ" }, "organization_membership_id": { "type": "string", "description": "The ID of the OrganizationMembership.", "example": "om_01EHWNCE74X7JSDV0X3SZ3KJNY" } }, "required": [ "group_id", "organization_membership_id" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "group.member_removed" }, "data": { "type": "object", "properties": { "group_id": { "type": "string", "description": "The ID of the Group.", "example": "group_01HXYZ123456789ABCDEFGHIJ" }, "organization_membership_id": { "type": "string", "description": "The ID of the OrganizationMembership.", "example": "om_01EHWNCE74X7JSDV0X3SZ3KJNY" } }, "required": [ "group_id", "organization_membership_id" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "group.updated" }, "data": { "$ref": "#/components/schemas/Group", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "invitation.accepted" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the invitation object.", "const": "invitation" }, "id": { "type": "string", "description": "The unique ID of the invitation.", "example": "invitation_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the recipient.", "example": "marcelina.davis@example.com" }, "state": { "type": "string", "enum": [ "pending", "accepted", "expired", "revoked" ], "description": "The state of the invitation.", "example": "pending" }, "accepted_at": { "format": "date-time", "type": [ "string", "null" ], "description": "The timestamp when the invitation was accepted, or null if not yet accepted.", "example": null }, "revoked_at": { "format": "date-time", "type": [ "string", "null" ], "description": "The timestamp when the invitation was revoked, or null if not revoked.", "example": null }, "expires_at": { "format": "date-time", "type": "string", "description": "The timestamp when the invitation expires.", "example": "2026-01-15T12:00:00.000Z" }, "organization_id": { "type": [ "string", "null" ], "description": "The ID of the [organization](/reference/organization) that the recipient will join.", "example": "org_01E4ZCR3C56J083X43JQXF3JK5" }, "inviter_user_id": { "type": [ "string", "null" ], "description": "The ID of the user who invited the recipient, if provided.", "example": "user_01HYGBX8ZGD19949T3BM4FW1C3" }, "accepted_user_id": { "type": [ "string", "null" ], "description": "The ID of the user who accepted the invitation, once accepted.", "example": null }, "role_slug": { "type": [ "string", "null" ], "description": "Slug of the role the invitee will be assigned on acceptance. Reflects the current role on the invitee's organization membership. null when the invitation has no associated organization.", "example": "admin" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "email", "state", "accepted_at", "revoked_at", "expires_at", "organization_id", "inviter_user_id", "accepted_user_id", "role_slug", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "invitation.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the invitation object.", "const": "invitation" }, "id": { "type": "string", "description": "The unique ID of the invitation.", "example": "invitation_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the recipient.", "example": "marcelina.davis@example.com" }, "state": { "type": "string", "enum": [ "pending", "accepted", "expired", "revoked" ], "description": "The state of the invitation.", "example": "pending" }, "accepted_at": { "format": "date-time", "type": [ "string", "null" ], "description": "The timestamp when the invitation was accepted, or null if not yet accepted.", "example": null }, "revoked_at": { "format": "date-time", "type": [ "string", "null" ], "description": "The timestamp when the invitation was revoked, or null if not revoked.", "example": null }, "expires_at": { "format": "date-time", "type": "string", "description": "The timestamp when the invitation expires.", "example": "2026-01-15T12:00:00.000Z" }, "organization_id": { "type": [ "string", "null" ], "description": "The ID of the [organization](/reference/organization) that the recipient will join.", "example": "org_01E4ZCR3C56J083X43JQXF3JK5" }, "inviter_user_id": { "type": [ "string", "null" ], "description": "The ID of the user who invited the recipient, if provided.", "example": "user_01HYGBX8ZGD19949T3BM4FW1C3" }, "accepted_user_id": { "type": [ "string", "null" ], "description": "The ID of the user who accepted the invitation, once accepted.", "example": null }, "role_slug": { "type": [ "string", "null" ], "description": "Slug of the role the invitee will be assigned on acceptance. Reflects the current role on the invitee's organization membership. null when the invitation has no associated organization.", "example": "admin" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "email", "state", "accepted_at", "revoked_at", "expires_at", "organization_id", "inviter_user_id", "accepted_user_id", "role_slug", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "invitation.resent" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the invitation object.", "const": "invitation" }, "id": { "type": "string", "description": "The unique ID of the invitation.", "example": "invitation_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the recipient.", "example": "marcelina.davis@example.com" }, "state": { "type": "string", "enum": [ "pending", "accepted", "expired", "revoked" ], "description": "The state of the invitation.", "example": "pending" }, "accepted_at": { "format": "date-time", "type": [ "string", "null" ], "description": "The timestamp when the invitation was accepted, or null if not yet accepted.", "example": null }, "revoked_at": { "format": "date-time", "type": [ "string", "null" ], "description": "The timestamp when the invitation was revoked, or null if not revoked.", "example": null }, "expires_at": { "format": "date-time", "type": "string", "description": "The timestamp when the invitation expires.", "example": "2026-01-15T12:00:00.000Z" }, "organization_id": { "type": [ "string", "null" ], "description": "The ID of the [organization](/reference/organization) that the recipient will join.", "example": "org_01E4ZCR3C56J083X43JQXF3JK5" }, "inviter_user_id": { "type": [ "string", "null" ], "description": "The ID of the user who invited the recipient, if provided.", "example": "user_01HYGBX8ZGD19949T3BM4FW1C3" }, "accepted_user_id": { "type": [ "string", "null" ], "description": "The ID of the user who accepted the invitation, once accepted.", "example": null }, "role_slug": { "type": [ "string", "null" ], "description": "Slug of the role the invitee will be assigned on acceptance. Reflects the current role on the invitee's organization membership. null when the invitation has no associated organization.", "example": "admin" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "email", "state", "accepted_at", "revoked_at", "expires_at", "organization_id", "inviter_user_id", "accepted_user_id", "role_slug", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "invitation.revoked" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the invitation object.", "const": "invitation" }, "id": { "type": "string", "description": "The unique ID of the invitation.", "example": "invitation_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the recipient.", "example": "marcelina.davis@example.com" }, "state": { "type": "string", "enum": [ "pending", "accepted", "expired", "revoked" ], "description": "The state of the invitation.", "example": "pending" }, "accepted_at": { "format": "date-time", "type": [ "string", "null" ], "description": "The timestamp when the invitation was accepted, or null if not yet accepted.", "example": null }, "revoked_at": { "format": "date-time", "type": [ "string", "null" ], "description": "The timestamp when the invitation was revoked, or null if not revoked.", "example": null }, "expires_at": { "format": "date-time", "type": "string", "description": "The timestamp when the invitation expires.", "example": "2026-01-15T12:00:00.000Z" }, "organization_id": { "type": [ "string", "null" ], "description": "The ID of the [organization](/reference/organization) that the recipient will join.", "example": "org_01E4ZCR3C56J083X43JQXF3JK5" }, "inviter_user_id": { "type": [ "string", "null" ], "description": "The ID of the user who invited the recipient, if provided.", "example": "user_01HYGBX8ZGD19949T3BM4FW1C3" }, "accepted_user_id": { "type": [ "string", "null" ], "description": "The ID of the user who accepted the invitation, once accepted.", "example": null }, "role_slug": { "type": [ "string", "null" ], "description": "Slug of the role the invitee will be assigned on acceptance. Reflects the current role on the invitee's organization membership. null when the invitation has no associated organization.", "example": "admin" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "email", "state", "accepted_at", "revoked_at", "expires_at", "organization_id", "inviter_user_id", "accepted_user_id", "role_slug", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "magic_auth.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the Magic Auth object.", "const": "magic_auth" }, "id": { "type": "string", "description": "The unique ID of the Magic Auth code.", "example": "magic_auth_01HWZBQZY2M3AMQW166Q22K88F" }, "user_id": { "type": "string", "description": "The unique ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the user.", "example": "marcelina.davis@example.com" }, "expires_at": { "format": "date-time", "type": "string", "description": "The timestamp when the Magic Auth code expires.", "example": "2026-01-15T12:00:00.000Z" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "user_id", "email", "expires_at", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the Organization object.", "const": "organization" }, "id": { "type": "string", "description": "Unique identifier of the Organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "name": { "type": "string", "description": "A descriptive name for the Organization. This field does not need to be unique.", "example": "Acme Inc." }, "domains": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization domain object.", "const": "organization_domain" }, "id": { "type": "string", "description": "Unique identifier of the organization domain.", "example": "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A" }, "organization_id": { "type": "string", "description": "ID of the parent Organization.", "example": "org_01HE8GSH8FQPASKSY27THRKRBP" }, "domain": { "type": "string", "description": "Domain for the organization domain.", "example": "foo-corp.com" }, "state": { "type": "string", "enum": [ "failed", "legacy_verified", "pending", "unverified", "verified" ], "description": "Verification state of the domain.", "example": "pending" }, "verification_prefix": { "type": "string", "description": "The prefix used in DNS verification.", "example": "superapp-domain-verification-z3kjny" }, "verification_token": { "type": "string", "description": "Validation token to be used in DNS TXT record.", "example": "m5Oztg3jdK4NJLgs8uIlIprMw" }, "verification_strategy": { "type": "string", "enum": [ "dns", "manual" ], "description": "Strategy used to verify the domain.", "example": "dns" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "organization_id", "domain", "created_at", "updated_at" ] }, "description": "List of Organization Domains." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 600 }, "description": "Object containing [metadata](/authkit/metadata) key/value pairs associated with the Organization.", "example": { "tier": "diamond" }, "propertyNames": { "maxLength": 40 }, "maxProperties": 50 }, "external_id": { "type": [ "string", "null" ], "description": "The external ID of the Organization.", "example": "2fe01467-f7ea-4dd2-8b79-c2b4f56d0191" }, "stripe_customer_id": { "type": "string", "description": "The Stripe customer ID of the Organization.", "example": "cus_R9qWAGMQ6nGE7V" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "name", "domains", "metadata", "external_id", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization.deleted" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the Organization object.", "const": "organization" }, "id": { "type": "string", "description": "Unique identifier of the Organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "name": { "type": "string", "description": "A descriptive name for the Organization. This field does not need to be unique.", "example": "Acme Inc." }, "domains": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization domain object.", "const": "organization_domain" }, "id": { "type": "string", "description": "Unique identifier of the organization domain.", "example": "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A" }, "organization_id": { "type": "string", "description": "ID of the parent Organization.", "example": "org_01HE8GSH8FQPASKSY27THRKRBP" }, "domain": { "type": "string", "description": "Domain for the organization domain.", "example": "foo-corp.com" }, "state": { "type": "string", "enum": [ "failed", "legacy_verified", "pending", "unverified", "verified" ], "description": "Verification state of the domain.", "example": "pending" }, "verification_prefix": { "type": "string", "description": "The prefix used in DNS verification.", "example": "superapp-domain-verification-z3kjny" }, "verification_token": { "type": "string", "description": "Validation token to be used in DNS TXT record.", "example": "m5Oztg3jdK4NJLgs8uIlIprMw" }, "verification_strategy": { "type": "string", "enum": [ "dns", "manual" ], "description": "Strategy used to verify the domain.", "example": "dns" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "organization_id", "domain", "created_at", "updated_at" ] }, "description": "List of Organization Domains." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 600 }, "description": "Object containing [metadata](/authkit/metadata) key/value pairs associated with the Organization.", "example": { "tier": "diamond" }, "propertyNames": { "maxLength": 40 }, "maxProperties": 50 }, "external_id": { "type": [ "string", "null" ], "description": "The external ID of the Organization.", "example": "2fe01467-f7ea-4dd2-8b79-c2b4f56d0191" }, "stripe_customer_id": { "type": "string", "description": "The Stripe customer ID of the Organization.", "example": "cus_R9qWAGMQ6nGE7V" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "name", "domains", "metadata", "external_id", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization_domain.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization domain object.", "const": "organization_domain" }, "id": { "type": "string", "description": "Unique identifier of the organization domain.", "example": "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A" }, "organization_id": { "type": "string", "description": "ID of the parent Organization.", "example": "org_01HE8GSH8FQPASKSY27THRKRBP" }, "domain": { "type": "string", "description": "Domain for the organization domain.", "example": "foo-corp.com" }, "state": { "type": "string", "enum": [ "failed", "legacy_verified", "pending", "unverified", "verified" ], "description": "Verification state of the domain.", "example": "pending" }, "verification_prefix": { "type": "string", "description": "The prefix used in DNS verification.", "example": "superapp-domain-verification-z3kjny" }, "verification_token": { "type": "string", "description": "Validation token to be used in DNS TXT record.", "example": "m5Oztg3jdK4NJLgs8uIlIprMw" }, "verification_strategy": { "type": "string", "enum": [ "dns", "manual" ], "description": "Strategy used to verify the domain.", "example": "dns" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "organization_id", "domain", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization_domain.deleted" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization domain object.", "const": "organization_domain" }, "id": { "type": "string", "description": "Unique identifier of the organization domain.", "example": "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A" }, "organization_id": { "type": "string", "description": "ID of the parent Organization.", "example": "org_01HE8GSH8FQPASKSY27THRKRBP" }, "domain": { "type": "string", "description": "Domain for the organization domain.", "example": "foo-corp.com" }, "state": { "type": "string", "enum": [ "failed", "legacy_verified", "pending", "unverified", "verified" ], "description": "Verification state of the domain.", "example": "pending" }, "verification_prefix": { "type": "string", "description": "The prefix used in DNS verification.", "example": "superapp-domain-verification-z3kjny" }, "verification_token": { "type": "string", "description": "Validation token to be used in DNS TXT record.", "example": "m5Oztg3jdK4NJLgs8uIlIprMw" }, "verification_strategy": { "type": "string", "enum": [ "dns", "manual" ], "description": "Strategy used to verify the domain.", "example": "dns" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "organization_id", "domain", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization_domain.updated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization domain object.", "const": "organization_domain" }, "id": { "type": "string", "description": "Unique identifier of the organization domain.", "example": "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A" }, "organization_id": { "type": "string", "description": "ID of the parent Organization.", "example": "org_01HE8GSH8FQPASKSY27THRKRBP" }, "domain": { "type": "string", "description": "Domain for the organization domain.", "example": "foo-corp.com" }, "state": { "type": "string", "enum": [ "failed", "legacy_verified", "pending", "unverified", "verified" ], "description": "Verification state of the domain.", "example": "pending" }, "verification_prefix": { "type": "string", "description": "The prefix used in DNS verification.", "example": "superapp-domain-verification-z3kjny" }, "verification_token": { "type": "string", "description": "Validation token to be used in DNS TXT record.", "example": "m5Oztg3jdK4NJLgs8uIlIprMw" }, "verification_strategy": { "type": "string", "enum": [ "dns", "manual" ], "description": "Strategy used to verify the domain.", "example": "dns" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "organization_id", "domain", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization_domain.verification_failed" }, "data": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "domain_verification_period_expired", "domain_verified_by_other_organization" ], "description": "The reason the domain verification failed.", "example": "domain_verification_period_expired" }, "organization_domain": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization domain object.", "const": "organization_domain" }, "id": { "type": "string", "description": "Unique identifier of the organization domain.", "example": "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A" }, "organization_id": { "type": "string", "description": "ID of the parent Organization.", "example": "org_01HE8GSH8FQPASKSY27THRKRBP" }, "domain": { "type": "string", "description": "Domain for the organization domain.", "example": "foo-corp.com" }, "state": { "type": "string", "enum": [ "failed", "legacy_verified", "pending", "unverified", "verified" ], "description": "Verification state of the domain.", "example": "pending" }, "verification_prefix": { "type": "string", "description": "The prefix used in DNS verification.", "example": "superapp-domain-verification-z3kjny" }, "verification_token": { "type": "string", "description": "Validation token to be used in DNS TXT record.", "example": "m5Oztg3jdK4NJLgs8uIlIprMw" }, "verification_strategy": { "type": "string", "enum": [ "dns", "manual" ], "description": "Strategy used to verify the domain.", "example": "dns" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "organization_id", "domain", "created_at", "updated_at" ], "description": "The organization domain that failed verification." } }, "required": [ "reason", "organization_domain" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization_domain.verified" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization domain object.", "const": "organization_domain" }, "id": { "type": "string", "description": "Unique identifier of the organization domain.", "example": "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A" }, "organization_id": { "type": "string", "description": "ID of the parent Organization.", "example": "org_01HE8GSH8FQPASKSY27THRKRBP" }, "domain": { "type": "string", "description": "Domain for the organization domain.", "example": "foo-corp.com" }, "state": { "type": "string", "enum": [ "failed", "legacy_verified", "pending", "unverified", "verified" ], "description": "Verification state of the domain.", "example": "pending" }, "verification_prefix": { "type": "string", "description": "The prefix used in DNS verification.", "example": "superapp-domain-verification-z3kjny" }, "verification_token": { "type": "string", "description": "Validation token to be used in DNS TXT record.", "example": "m5Oztg3jdK4NJLgs8uIlIprMw" }, "verification_strategy": { "type": "string", "enum": [ "dns", "manual" ], "description": "Strategy used to verify the domain.", "example": "dns" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "organization_id", "domain", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization_membership.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization membership object.", "const": "organization_membership" }, "id": { "type": "string", "description": "Unique identifier of the organization membership.", "example": "om_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "user_id": { "type": "string", "description": "The ID of the user.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "organization_id": { "type": "string", "description": "The ID of the organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "status": { "type": "string", "enum": [ "active", "inactive", "pending" ], "description": "The status of the organization membership.", "example": "active" }, "role": { "$ref": "#/components/schemas/SlimRole", "description": "The role associated with the membership." }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/SlimRole" }, "description": "The roles associated with the membership." }, "custom_attributes": { "type": "object", "additionalProperties": {}, "description": "Custom attributes associated with the membership." }, "directory_managed": { "type": "boolean", "description": "Whether the membership is managed by a directory sync provider.", "example": false }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "user_id", "organization_id", "status", "role", "custom_attributes", "directory_managed", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization_membership.deleted" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization membership object.", "const": "organization_membership" }, "id": { "type": "string", "description": "Unique identifier of the organization membership.", "example": "om_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "user_id": { "type": "string", "description": "The ID of the user.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "organization_id": { "type": "string", "description": "The ID of the organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "status": { "type": "string", "enum": [ "active", "inactive", "pending" ], "description": "The status of the organization membership.", "example": "active" }, "role": { "$ref": "#/components/schemas/SlimRole", "description": "The role associated with the membership." }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/SlimRole" }, "description": "The roles associated with the membership." }, "custom_attributes": { "type": "object", "additionalProperties": {}, "description": "Custom attributes associated with the membership." }, "directory_managed": { "type": "boolean", "description": "Whether the membership is managed by a directory sync provider.", "example": false }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "user_id", "organization_id", "status", "role", "custom_attributes", "directory_managed", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization_membership.updated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization membership object.", "const": "organization_membership" }, "id": { "type": "string", "description": "Unique identifier of the organization membership.", "example": "om_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "user_id": { "type": "string", "description": "The ID of the user.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "organization_id": { "type": "string", "description": "The ID of the organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "status": { "type": "string", "enum": [ "active", "inactive", "pending" ], "description": "The status of the organization membership.", "example": "active" }, "role": { "$ref": "#/components/schemas/SlimRole", "description": "The role associated with the membership." }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/SlimRole" }, "description": "The roles associated with the membership." }, "custom_attributes": { "type": "object", "additionalProperties": {}, "description": "Custom attributes associated with the membership." }, "directory_managed": { "type": "boolean", "description": "Whether the membership is managed by a directory sync provider.", "example": false }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "user_id", "organization_id", "status", "role", "custom_attributes", "directory_managed", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization_role.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization role object.", "const": "organization_role" }, "organization_id": { "type": "string", "description": "The ID of the organization the role belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "slug": { "type": "string", "description": "The slug identifier of the role.", "example": "billing-admin" }, "name": { "type": "string", "description": "The name of the role.", "example": "Billing Administrator" }, "description": { "type": [ "string", "null" ], "description": "A description of the role.", "example": "Can manage billing settings." }, "resource_type_slug": { "type": "string", "description": "The slug of the resource type the role applies to.", "example": "organization" }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The permissions granted by the role.", "example": [ "users:read", "users:write" ] }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "organization_id", "slug", "name", "description", "resource_type_slug", "permissions", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization_role.deleted" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization role object.", "const": "organization_role" }, "organization_id": { "type": "string", "description": "The ID of the organization the role belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "slug": { "type": "string", "description": "The slug identifier of the role.", "example": "billing-admin" }, "name": { "type": "string", "description": "The name of the role.", "example": "Billing Administrator" }, "description": { "type": [ "string", "null" ], "description": "A description of the role.", "example": "Can manage billing settings." }, "resource_type_slug": { "type": "string", "description": "The slug of the resource type the role applies to.", "example": "organization" }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The permissions granted by the role.", "example": [ "users:read", "users:write" ] }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "organization_id", "slug", "name", "description", "resource_type_slug", "permissions", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization_role.updated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization role object.", "const": "organization_role" }, "organization_id": { "type": "string", "description": "The ID of the organization the role belongs to.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "slug": { "type": "string", "description": "The slug identifier of the role.", "example": "billing-admin" }, "name": { "type": "string", "description": "The name of the role.", "example": "Billing Administrator" }, "description": { "type": [ "string", "null" ], "description": "A description of the role.", "example": "Can manage billing settings." }, "resource_type_slug": { "type": "string", "description": "The slug of the resource type the role applies to.", "example": "organization" }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The permissions granted by the role.", "example": [ "users:read", "users:write" ] }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "organization_id", "slug", "name", "description", "resource_type_slug", "permissions", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "organization.updated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the Organization object.", "const": "organization" }, "id": { "type": "string", "description": "Unique identifier of the Organization.", "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "name": { "type": "string", "description": "A descriptive name for the Organization. This field does not need to be unique.", "example": "Acme Inc." }, "domains": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the organization domain object.", "const": "organization_domain" }, "id": { "type": "string", "description": "Unique identifier of the organization domain.", "example": "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A" }, "organization_id": { "type": "string", "description": "ID of the parent Organization.", "example": "org_01HE8GSH8FQPASKSY27THRKRBP" }, "domain": { "type": "string", "description": "Domain for the organization domain.", "example": "foo-corp.com" }, "state": { "type": "string", "enum": [ "failed", "legacy_verified", "pending", "unverified", "verified" ], "description": "Verification state of the domain.", "example": "pending" }, "verification_prefix": { "type": "string", "description": "The prefix used in DNS verification.", "example": "superapp-domain-verification-z3kjny" }, "verification_token": { "type": "string", "description": "Validation token to be used in DNS TXT record.", "example": "m5Oztg3jdK4NJLgs8uIlIprMw" }, "verification_strategy": { "type": "string", "enum": [ "dns", "manual" ], "description": "Strategy used to verify the domain.", "example": "dns" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "organization_id", "domain", "created_at", "updated_at" ] }, "description": "List of Organization Domains." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 600 }, "description": "Object containing [metadata](/authkit/metadata) key/value pairs associated with the Organization.", "example": { "tier": "diamond" }, "propertyNames": { "maxLength": 40 }, "maxProperties": 50 }, "external_id": { "type": [ "string", "null" ], "description": "The external ID of the Organization.", "example": "2fe01467-f7ea-4dd2-8b79-c2b4f56d0191" }, "stripe_customer_id": { "type": "string", "description": "The Stripe customer ID of the Organization.", "example": "cus_R9qWAGMQ6nGE7V" }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "name", "domains", "metadata", "external_id", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "password_reset.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the password reset object.", "const": "password_reset" }, "id": { "type": "string", "description": "The unique ID of the password reset object.", "example": "password_reset_01E4ZCR3C56J083X43JQXF3JK5" }, "user_id": { "type": "string", "description": "The unique ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the user.", "example": "marcelina.davis@example.com" }, "expires_at": { "format": "date-time", "type": "string", "description": "The timestamp when the password reset token expires.", "example": "2026-01-15T12:00:00.000Z" }, "created_at": { "format": "date-time", "type": "string", "description": "The timestamp when the password reset token was created.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "user_id", "email", "expires_at", "created_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "password_reset.succeeded" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the password reset object.", "const": "password_reset" }, "id": { "type": "string", "description": "The unique ID of the password reset object.", "example": "password_reset_01E4ZCR3C56J083X43JQXF3JK5" }, "user_id": { "type": "string", "description": "The unique ID of the user.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "email": { "type": "string", "description": "The email address of the user.", "example": "marcelina.davis@example.com" }, "expires_at": { "format": "date-time", "type": "string", "description": "The timestamp when the password reset token expires.", "example": "2026-01-15T12:00:00.000Z" }, "created_at": { "format": "date-time", "type": "string", "description": "The timestamp when the password reset token was created.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "user_id", "email", "expires_at", "created_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "permission.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the permission object.", "const": "permission" }, "id": { "type": "string", "description": "Unique identifier of the permission.", "example": "perm_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "slug": { "type": "string", "description": "The slug identifier of the permission.", "example": "billing:manage" }, "name": { "type": "string", "description": "The name of the permission.", "example": "Manage Billing" }, "description": { "type": [ "string", "null" ], "description": "A description of the permission.", "example": "Allows managing billing settings." }, "system": { "type": "boolean", "description": "Whether the permission is a system permission.", "example": false }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "slug", "name", "description", "system", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "permission.deleted" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the permission object.", "const": "permission" }, "id": { "type": "string", "description": "Unique identifier of the permission.", "example": "perm_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "slug": { "type": "string", "description": "The slug identifier of the permission.", "example": "billing:manage" }, "name": { "type": "string", "description": "The name of the permission.", "example": "Manage Billing" }, "description": { "type": [ "string", "null" ], "description": "A description of the permission.", "example": "Allows managing billing settings." }, "system": { "type": "boolean", "description": "Whether the permission is a system permission.", "example": false }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "slug", "name", "description", "system", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "permission.updated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the permission object.", "const": "permission" }, "id": { "type": "string", "description": "Unique identifier of the permission.", "example": "perm_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "slug": { "type": "string", "description": "The slug identifier of the permission.", "example": "billing:manage" }, "name": { "type": "string", "description": "The name of the permission.", "example": "Manage Billing" }, "description": { "type": [ "string", "null" ], "description": "A description of the permission.", "example": "Allows managing billing settings." }, "system": { "type": "boolean", "description": "Whether the permission is a system permission.", "example": false }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "slug", "name", "description", "system", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "role.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the role object.", "const": "role" }, "slug": { "type": "string", "description": "The slug identifier of the role.", "example": "admin" }, "resource_type_slug": { "type": "string", "description": "The slug of the resource type the role applies to.", "example": "organization" }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The permissions granted by the role.", "example": [ "users:read", "users:write" ] }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "slug", "resource_type_slug", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "role.deleted" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the role object.", "const": "role" }, "slug": { "type": "string", "description": "The slug identifier of the role.", "example": "admin" }, "resource_type_slug": { "type": "string", "description": "The slug of the resource type the role applies to.", "example": "organization" }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The permissions granted by the role.", "example": [ "users:read", "users:write" ] }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "slug", "resource_type_slug", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "role.updated" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the role object.", "const": "role" }, "slug": { "type": "string", "description": "The slug identifier of the role.", "example": "admin" }, "resource_type_slug": { "type": "string", "description": "The slug of the resource type the role applies to.", "example": "organization" }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The permissions granted by the role.", "example": [ "users:read", "users:write" ] }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "slug", "resource_type_slug", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "session.created" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the session object.", "const": "session" }, "id": { "type": "string", "description": "The unique ID of the session.", "example": "session_01H93ZY4F80QPBEZ1R5B2SHQG8" }, "impersonator": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the WorkOS Dashboard user who is impersonating the user.", "example": "admin@foocorp.com" }, "reason": { "type": [ "string", "null" ], "description": "The justification the impersonator gave for impersonating the user.", "example": "Investigating an issue with the customer's account." } }, "required": [ "email", "reason" ], "description": "Information about the impersonator if this session was created via impersonation." }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address from which the session was created.", "example": "198.51.100.42" }, "organization_id": { "type": "string", "description": "The ID of the organization this session is associated with.", "example": "org_01H945H0YD4F97JN9MATX7BYAG" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent string from the device that created the session.", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36" }, "user_id": { "type": "string", "description": "The ID of the user this session belongs to.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "auth_method": { "type": "string", "enum": [ "cross_app_auth", "external_auth", "impersonation", "magic_code", "migrated_session", "oauth", "passkey", "password", "sso", "unknown" ], "description": "The authentication method used to create this session.", "example": "sso" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ], "description": "The current status of the session.", "example": "active" }, "expires_at": { "format": "date-time", "type": "string", "description": "The timestamp when the session expires.", "example": "2026-01-15T12:00:00.000Z" }, "ended_at": { "format": "date-time", "type": [ "string", "null" ], "description": "The timestamp when the session ended.", "example": null }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "ip_address", "user_agent", "user_id", "auth_method", "status", "expires_at", "ended_at", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "session.revoked" }, "data": { "type": "object", "properties": { "object": { "type": "string", "description": "Distinguishes the session object.", "const": "session" }, "id": { "type": "string", "description": "The unique ID of the session.", "example": "session_01H93ZY4F80QPBEZ1R5B2SHQG8" }, "impersonator": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the WorkOS Dashboard user who is impersonating the user.", "example": "admin@foocorp.com" }, "reason": { "type": [ "string", "null" ], "description": "The justification the impersonator gave for impersonating the user.", "example": "Investigating an issue with the customer's account." } }, "required": [ "email", "reason" ], "description": "Information about the impersonator if this session was created via impersonation." }, "ip_address": { "type": [ "string", "null" ], "description": "The IP address from which the session was created.", "example": "198.51.100.42" }, "organization_id": { "type": "string", "description": "The ID of the organization this session is associated with.", "example": "org_01H945H0YD4F97JN9MATX7BYAG" }, "user_agent": { "type": [ "string", "null" ], "description": "The user agent string from the device that created the session.", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36" }, "user_id": { "type": "string", "description": "The ID of the user this session belongs to.", "example": "user_01E4ZCR3C56J083X43JQXF3JK5" }, "auth_method": { "type": "string", "enum": [ "cross_app_auth", "external_auth", "impersonation", "magic_code", "migrated_session", "oauth", "passkey", "password", "sso", "unknown" ], "description": "The authentication method used to create this session.", "example": "sso" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ], "description": "The current status of the session.", "example": "active" }, "expires_at": { "format": "date-time", "type": "string", "description": "The timestamp when the session expires.", "example": "2026-01-15T12:00:00.000Z" }, "ended_at": { "format": "date-time", "type": [ "string", "null" ], "description": "The timestamp when the session ended.", "example": null }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "updated_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" } }, "required": [ "object", "id", "ip_address", "user_agent", "user_id", "auth_method", "status", "expires_at", "ended_at", "created_at", "updated_at" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "user.created" }, "data": { "$ref": "#/components/schemas/UserlandUser", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "user.deleted" }, "data": { "$ref": "#/components/schemas/UserlandUser", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "user.updated" }, "data": { "$ref": "#/components/schemas/UserlandUser", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "vault.byok_key.deleted" }, "data": { "type": "object", "properties": { "organization_id": { "type": "string", "description": "The unique identifier of the organization.", "example": "org_01EHT88Z8J8795GZNQ4ZP1J81T" }, "key_provider": { "$ref": "#/components/schemas/VaultByokKeyProvider" } }, "required": [ "organization_id", "key_provider" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "vault.byok_key.verification_completed" }, "data": { "type": "object", "properties": { "organization_id": { "type": "string", "description": "The unique identifier of the organization.", "example": "org_01EHT88Z8J8795GZNQ4ZP1J81T" }, "key_provider": { "$ref": "#/components/schemas/VaultByokKeyProvider" }, "verified": { "type": "boolean", "description": "Whether the BYOK key verification completed successfully.", "example": true } }, "required": [ "organization_id", "key_provider", "verified" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "vault.data.created" }, "data": { "type": "object", "properties": { "actor_id": { "type": "string", "description": "The unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor_source": { "type": "string", "enum": [ "api", "dashboard" ] }, "actor_name": { "type": "string", "description": "The name of the actor.", "example": "Jane Doe" }, "kv_name": { "type": "string", "description": "The name of the key-value store.", "example": "user-secrets" }, "key_id": { "type": "string", "description": "The unique identifier of the encryption key.", "example": "key_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "key_context": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "actor_id", "actor_source", "actor_name", "kv_name", "key_id", "key_context" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "vault.data.deleted" }, "data": { "type": "object", "properties": { "actor_id": { "type": "string", "description": "The unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor_source": { "type": "string", "enum": [ "api", "dashboard" ] }, "actor_name": { "type": "string", "description": "The name of the actor.", "example": "Jane Doe" }, "kv_name": { "type": "string", "description": "The name of the key-value store.", "example": "user-secrets" } }, "required": [ "actor_id", "actor_source", "actor_name", "kv_name" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "vault.data.read" }, "data": { "type": "object", "properties": { "actor_id": { "type": "string", "description": "The unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor_source": { "type": "string", "enum": [ "api", "dashboard" ] }, "actor_name": { "type": "string", "description": "The name of the actor.", "example": "Jane Doe" }, "kv_name": { "type": "string", "description": "The name of the key-value store.", "example": "user-secrets" }, "key_id": { "type": "string", "description": "The unique identifier of the encryption key.", "example": "key_01EHWNCE74X7JSDV0X3SZ3KJNY" } }, "required": [ "actor_id", "actor_source", "actor_name", "kv_name", "key_id" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "vault.data.updated" }, "data": { "type": "object", "properties": { "actor_id": { "type": "string", "description": "The unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor_source": { "type": "string", "enum": [ "api", "dashboard" ] }, "actor_name": { "type": "string", "description": "The name of the actor.", "example": "Jane Doe" }, "kv_name": { "type": "string", "description": "The name of the key-value store.", "example": "user-secrets" }, "key_id": { "type": "string", "description": "The unique identifier of the encryption key.", "example": "key_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "key_context": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "actor_id", "actor_source", "actor_name", "kv_name", "key_id", "key_context" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "vault.dek.decrypted" }, "data": { "type": "object", "properties": { "actor_id": { "type": "string", "description": "The unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor_source": { "type": "string", "enum": [ "api", "dashboard" ] }, "actor_name": { "type": "string", "description": "The name of the actor.", "example": "Jane Doe" }, "key_id": { "type": "string", "description": "The unique identifier of the data encryption key.", "example": "key_01EHWNCE74X7JSDV0X3SZ3KJNY" } }, "required": [ "actor_id", "actor_source", "actor_name", "key_id" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "vault.dek.read" }, "data": { "type": "object", "properties": { "actor_id": { "type": "string", "description": "The unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor_source": { "type": "string", "enum": [ "api", "dashboard" ] }, "actor_name": { "type": "string", "description": "The name of the actor.", "example": "Jane Doe" }, "key_ids": { "type": "array", "items": { "type": "string" }, "description": "The unique identifiers of the data encryption keys.", "example": [ "dek_01EHWNCE74X7JSDV0X3SZ3KJNY" ] }, "key_context": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "actor_id", "actor_source", "actor_name", "key_ids", "key_context" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "vault.kek.created" }, "data": { "type": "object", "properties": { "actor_id": { "type": "string", "description": "The unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor_source": { "type": "string", "enum": [ "api", "dashboard" ] }, "actor_name": { "type": "string", "description": "The name of the actor.", "example": "Jane Doe" }, "key_name": { "type": "string", "description": "The name of the key encryption key.", "example": "production-kek" }, "key_id": { "type": "string", "description": "The unique identifier of the key encryption key.", "example": "key_01EHWNCE74X7JSDV0X3SZ3KJNY" } }, "required": [ "actor_id", "actor_source", "actor_name", "key_name", "key_id" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "vault.metadata.read" }, "data": { "type": "object", "properties": { "actor_id": { "type": "string", "description": "The unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor_source": { "type": "string", "enum": [ "api", "dashboard" ] }, "actor_name": { "type": "string", "description": "The name of the actor.", "example": "Jane Doe" }, "kv_name": { "type": "string", "description": "The name of the key-value store.", "example": "user-secrets" } }, "required": [ "actor_id", "actor_source", "actor_name", "kv_name" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "vault.names.listed" }, "data": { "type": "object", "properties": { "actor_id": { "type": "string", "description": "The unique identifier of the actor.", "example": "user_01EHWNCE74X7JSDV0X3SZ3KJNY" }, "actor_source": { "type": "string", "enum": [ "api", "dashboard" ] }, "actor_name": { "type": "string", "description": "The name of the actor.", "example": "Jane Doe" } }, "required": [ "actor_id", "actor_source", "actor_name" ], "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "waitlist_user.approved" }, "data": { "$ref": "#/components/schemas/WaitlistUser", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "waitlist_user.created" }, "data": { "$ref": "#/components/schemas/WaitlistUser", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] }, { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the event.", "example": "event_01EHZNVPK3SFK441A1RGBFSHRT" }, "event": { "type": "string", "const": "waitlist_user.denied" }, "data": { "$ref": "#/components/schemas/WaitlistUser", "description": "The event payload." }, "created_at": { "format": "date-time", "type": "string", "description": "An ISO 8601 timestamp.", "example": "2026-01-15T12:00:00.000Z" }, "context": { "$ref": "#/components/schemas/EventContextDto" }, "object": { "type": "string", "description": "Distinguishes the Event object.", "const": "event" } }, "required": [ "id", "event", "data", "created_at", "object" ] } ] } ], "example": { "object": "event", "id": "event_01EHZNVPK3SFK441A1RGBFSHRT", "event": "dsync.user.created", "data": { "id": "directory_user_01E1JG7J09H96KYP8HM9B0G5SJ", "directory_id": "directory_01ECAZ4NV9QMV47GW873HDCX74", "organization_id": "org_01EZTR6WYX1A0DSE2CYMGXQ24Y", "state": "active", "email": "veda@foo-corp.com", "emails": [ { "primary": true, "type": "work", "value": "veda@foo-corp.com" } ], "idp_id": "2836", "object": "directory_user", "username": "veda@foo-corp.com", "last_name": "Torp", "first_name": "Veda", "raw_attributes": {}, "custom_attributes": {}, "created_at": "2021-06-25T19:07:33.155Z", "updated_at": "2021-06-25T19:07:33.155Z" }, "created_at": "2021-06-25T19:07:33.155Z", "context": {} }, "description": "An event emitted by WorkOS." }