Skip to main content

Use Webhooks to Keep Your Backend in Sync

Every webhook delivery uses this envelope:
{
  "type": "<event_name>",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {}
}
data is the delivered event payload.

User Events

user.created

{
  "type": "user.created",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "12345",
    "entity_type": "user",
    "id": "12345",
    "first_name": "Ava",
    "last_name": "Stone",
    "username": "ava",
    "profile_picture_url": "",
    "schema_version": "v1",
    "disabled": false,
    "second_factor_policy": "optional",
    "availability": "active",
    "last_password_reset_at": null,
    "active_organization_membership_id": null,
    "active_workspace_membership_id": null,
    "deployment_id": "24239923154394947",
    "public_metadata": {},
    "private_metadata": {},
    "primary_email_address_id": "4001",
    "primary_email_address": "ava@example.com",
    "primary_phone_number_id": "5001",
    "primary_phone_number": "+15551234567",
    "email_addresses": [],
    "phone_numbers": [],
    "social_connections": [],
    "segments": [],
    "has_password": true,
    "has_backup_codes": false
  }
}

user.updated

{
  "type": "user.updated",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "12345",
    "entity_type": "user",
    "id": "12345",
    "first_name": "Ava",
    "last_name": "Stone",
    "username": "ava",
    "profile_picture_url": "",
    "schema_version": "v1",
    "disabled": false,
    "second_factor_policy": "optional",
    "availability": "active",
    "last_password_reset_at": null,
    "active_organization_membership_id": null,
    "active_workspace_membership_id": null,
    "deployment_id": "24239923154394947",
    "public_metadata": {},
    "private_metadata": {},
    "primary_email_address_id": "4001",
    "primary_email_address": "ava@example.com",
    "primary_phone_number_id": "5001",
    "primary_phone_number": "+15551234567",
    "email_addresses": [],
    "phone_numbers": [],
    "social_connections": [],
    "segments": [],
    "has_password": true,
    "has_backup_codes": false
  }
}

user.deleted

{
  "type": "user.deleted",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "12345",
    "entity_type": "user",
    "id": "12345",
    "first_name": "Ava",
    "last_name": "Stone",
    "username": "ava"
  }
}

user.email.added

{
  "type": "user.email.added",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "4001",
    "entity_type": "user_email"
  }
}

user.email.removed

{
  "type": "user.email.removed",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "4001",
    "entity_type": "user_email"
  }
}

user.email.verified

{
  "type": "user.email.verified",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "4001",
    "entity_type": "user_email"
  }
}

user.phone.added

{
  "type": "user.phone.added",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "5001",
    "entity_type": "user_phone"
  }
}

user.phone.removed

{
  "type": "user.phone.removed",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "5001",
    "entity_type": "user_phone"
  }
}

user.phone.verified

{
  "type": "user.phone.verified",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "5001",
    "entity_type": "user_phone"
  }
}

user.password.updated

{
  "type": "user.password.updated",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "12345",
    "entity_type": "user"
  }
}

user.mfa.enabled

{
  "type": "user.mfa.enabled",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "12345",
    "entity_type": "user_authenticator",
    "id": "991",
    "created_at": "2026-03-04T09:59:00Z",
    "updated_at": "2026-03-04T10:00:00Z",
    "user_id": "12345",
    "otp_url": "otpauth://totp/Wacht:ava@example.com?secret=***"
  }
}

user.mfa.disabled

{
  "type": "user.mfa.disabled",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "12345",
    "entity_type": "user_authenticator",
    "id": "991",
    "created_at": "2026-03-04T09:59:00Z",
    "updated_at": "2026-03-04T10:00:00Z",
    "user_id": "12345",
    "otp_url": null
  }
}

Session Events

session.created

{
  "type": "session.created",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "7001",
    "entity_type": "session",
    "id": "7001",
    "created_at": "2026-03-04T10:00:00Z",
    "updated_at": "2026-03-04T10:00:00Z",
    "active_signin_id": "7101",
    "signins": []
  }
}

session.deleted

{
  "type": "session.deleted",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "7001",
    "entity_type": "session",
    "id": "7001",
    "created_at": "2026-03-04T10:00:00Z",
    "updated_at": "2026-03-04T10:00:00Z",
    "active_signin_id": "7101",
    "signins": []
  }
}

session.expired

{
  "type": "session.expired",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "7001",
    "entity_type": "session"
  }
}

Organization Events

organization.created

{
  "type": "organization.created",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "8001",
    "entity_type": "organization",
    "id": "8001",
    "name": "Acme Inc",
    "image_url": "",
    "description": "",
    "member_count": 1,
    "public_metadata": {},
    "private_metadata": {},
    "roles": [],
    "workspaces": [],
    "segments": []
  }
}

organization.updated

{
  "type": "organization.updated",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "8001",
    "entity_type": "organization",
    "id": "8001",
    "name": "Acme Inc"
  }
}

organization.deleted

{
  "type": "organization.deleted",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "8001",
    "entity_type": "organization"
  }
}

organization.member.added

{
  "type": "organization.member.added",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "8101",
    "entity_type": "organization_membership"
  }
}

organization.member.removed

{
  "type": "organization.member.removed",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "8101",
    "entity_type": "organization_membership"
  }
}

organization.member.role.updated

{
  "type": "organization.member.role.updated",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "8101",
    "entity_type": "organization_membership"
  }
}

organization.invitation.created

{
  "type": "organization.invitation.created",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "8201",
    "entity_type": "organization_invitation"
  }
}

organization.invitation.accepted

{
  "type": "organization.invitation.accepted",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "8201",
    "entity_type": "organization_invitation"
  }
}

organization.invitation.revoked

{
  "type": "organization.invitation.revoked",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "8201",
    "entity_type": "organization_invitation"
  }
}

Workspace Events

workspace.created

{
  "type": "workspace.created",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "9001",
    "entity_type": "workspace",
    "id": "9001",
    "name": "Production",
    "image_url": "",
    "description": "",
    "member_count": 2,
    "public_metadata": {},
    "private_metadata": {},
    "organization_id": "8001",
    "organization_name": "Acme Inc",
    "roles": [],
    "segments": []
  }
}

workspace.updated

{
  "type": "workspace.updated",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "9001",
    "entity_type": "workspace",
    "id": "9001",
    "name": "Production"
  }
}

workspace.deleted

{
  "type": "workspace.deleted",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "9001",
    "entity_type": "workspace"
  }
}

workspace.member.added

{
  "type": "workspace.member.added",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "9101",
    "entity_type": "workspace_membership"
  }
}

workspace.member.removed

{
  "type": "workspace.member.removed",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "9101",
    "entity_type": "workspace_membership"
  }
}

workspace.member.role.updated

{
  "type": "workspace.member.role.updated",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "9101",
    "entity_type": "workspace_membership"
  }
}

workspace.invitation.created

{
  "type": "workspace.invitation.created",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "9201",
    "entity_type": "workspace_invitation"
  }
}

workspace.invitation.accepted

{
  "type": "workspace.invitation.accepted",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "9201",
    "entity_type": "workspace_invitation"
  }
}

workspace.invitation.revoked

{
  "type": "workspace.invitation.revoked",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "9201",
    "entity_type": "workspace_invitation"
  }
}

API Key Events

api_key.created

{
  "type": "api_key.created",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "10001",
    "entity_type": "api_key"
  }
}

api_key.deleted

{
  "type": "api_key.deleted",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "10001",
    "entity_type": "api_key"
  }
}

api_key.rotated

{
  "type": "api_key.rotated",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "10001",
    "entity_type": "api_key"
  }
}

Agent Events

agent.created

{
  "type": "agent.created",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "11001",
    "entity_type": "agent"
  }
}

agent.updated

{
  "type": "agent.updated",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "11001",
    "entity_type": "agent"
  }
}

agent.deleted

{
  "type": "agent.deleted",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "11001",
    "entity_type": "agent"
  }
}

agent.execution.started

{
  "type": "agent.execution.started",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "11101",
    "entity_type": "agent_execution"
  }
}

agent.execution.completed

{
  "type": "agent.execution.completed",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "11101",
    "entity_type": "agent_execution"
  }
}

agent.execution.failed

{
  "type": "agent.execution.failed",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "11101",
    "entity_type": "agent_execution"
  }
}

agent.model.usage

{
  "type": "agent.model.usage",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "model": "gemini-2.5-flash",
    "is_byok": false,
    "context_id": "1234567890123456789",
    "context_group": "support",
    "input_tokens": 120,
    "cached_tokens": 0,
    "output_tokens": 32,
    "input_cost_cents": 1,
    "output_cost_cents": 1,
    "search_query_count": 0,
    "search_query_unique_count": 0,
    "search_query_cost_cents": 0,
    "total_cost_cents": 2,
    "timestamp": "2026-03-04T10:00:00Z",
    "prompt_token_count": 120,
    "candidates_token_count": 32,
    "total_token_count": 152,
    "cached_content_token_count": 0,
    "thoughts_token_count": 0
  }
}

Execution Context Events

execution_context.message

{
  "type": "execution_context.message",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "context_id": "1234567890123456789",
    "message_type": "conversation_message",
    "data": {},
    "timestamp": "2026-03-04T10:00:00Z"
  }
}

execution_context.platform_event

{
  "type": "execution_context.platform_event",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "context_id": "1234567890123456789",
    "message_type": "platform_event",
    "data": {
      "event_label": "tool.started",
      "event_data": {}
    },
    "timestamp": "2026-03-04T10:00:00Z"
  }
}

execution_context.platform_function

{
  "type": "execution_context.platform_function",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "context_id": "1234567890123456789",
    "message_type": "platform_function",
    "data": {
      "function_name": "search_docs",
      "function_data": {}
    },
    "timestamp": "2026-03-04T10:00:00Z"
  }
}

execution_context.user_input_request

{
  "type": "execution_context.user_input_request",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "context_id": "1234567890123456789",
    "message_type": "user_input_request",
    "data": {},
    "timestamp": "2026-03-04T10:00:00Z"
  }
}

execution_context.platform_function_result

{
  "type": "execution_context.platform_function_result",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "context_id": "1234567890123456789",
    "message_type": "platform_function",
    "execution_id": "exec_123",
    "data": {},
    "timestamp": "2026-03-04T10:00:00Z"
  }
}

Waitlist Events

waitlist.entry.created

{
  "type": "waitlist.entry.created",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "12001",
    "entity_type": "waitlist_entry"
  }
}

waitlist.entry.approved

{
  "type": "waitlist.entry.approved",
  "timestamp": "2026-03-04T10:00:00.000Z",
  "data": {
    "entity_id": "12001",
    "entity_type": "waitlist_entry"
  }
}