Webhook

User Organization Membership Updated

​

Triggered when a user's organization membership is updated, e.g., change of user's role in an organization

Body·
application/json
  • environment_id
    Type: string
    min length:  
    1
    max length:  
    32     Pattern: ^env_
    required

    The environment ID where the event occurred

  • id
    Type: string
    min length:  
    1
    max length:  
    32     Pattern: ^evt_
    required

    Unique identifier for the webhook event (must be prefixed with "evt_")

  • object
    Type: stringenum
    required

    The type of object that triggered the webhook

    values
    • Organization
    • Connection
    • Role
    • Directory
    • DirectoryUser
    • DirectoryGroup
    • Permission
    • OrgMembership
    • User
  • occurred_at
    Type: stringFormat: date-time
    required

    When the event occurred (ISO 8601 format)

  • spec_version
    Type: string Pattern: ^[0-9]+$
    required

    The webhook specification version

  • type
    Type: stringenum
    required

    The event type

    values
    • organization.created
    • organization.updated
    • organization.deleted
    • organization.sso_created
    • organization.sso_deleted
  • data
    Type: object

    The event payload (structure varies by event type)

  • display_name
    Type: string
    min length:  
    1
    max length:  
    200

    Human-readable display name for the event

  • organization_id
    Type: string
    min length:  
    1
    max length:  
    32     Pattern: ^org_

    The organization ID (if applicable)

Responses
  • 200

    Webhook received successfully

Request Example for postuser.organization_membership_updated
{
  "spec_version": "1",
  "id": "evt_6789012345",
  "type": "user.organization_membership_updated",
  "object": "OrgMembership",
  "occurred_at": "2024-01-15T11:10:00.123456789Z",
  "environment_id": "env_1234567890",
  "organization_id": "org_102690563312124938",
  "data": {
    "organization": {
      "id": "org_102690563312124938",
      "create_time": "2025-12-09T10:19:05.48Z",
      "display_name": "Acme Corp",
      "external_id": "org_external_123",
      "metadata": null,
      "region_code": "US",
      "update_time": "2025-12-09T12:04:41.386974738Z",
      "settings": {
        "features": [
          {
            "enabled": true,
            "name": "sso"
          },
          {
            "enabled": true,
            "name": "dir_sync"
          }
        ]
      }
    },
    "user": {
      "create_time": "2025-12-09T12:04:41.39Z",
      "email": "john.doe@acmecorp.com",
      "external_id": "ext_123456789",
      "id": "usr_123456789",
      "metadata": {},
      "update_time": "2025-12-09T12:04:41.391988Z",
      "user_profile": {
        "custom_attributes": null,
        "email_verified": true,
        "external_identities": [
          {
            "connection_id": "conn_97896332307464201",
            "connection_provider": "GOOGLE",
            "connection_type": "OAUTH",
            "connection_user_id": "105055379523565727691",
            "created_time": "2025-12-09T12:04:41.47Z",
            "is_social": true,
            "last_login_time": "2025-12-09T12:04:41.469311Z",
            "last_synced_time": "2025-12-09T12:04:41.469311Z",
            "raw_attributes": "{}",
            "updated_time": "2025-12-09T12:04:41.473087Z"
          }
        ],
        "family_name": "Doe",
        "gender": "",
        "given_name": "John",
        "locale": "",
        "metadata": {},
        "name": "John Doe",
        "phone_number": "",
        "phone_number_verified": false,
        "picture": "https://lh3.googleusercontent.com/a/abcdef",
        "preferred_username": ""
      }
    }
  },
  "display_name": "User Organization Membership Updated"
}
No Body

Webhook received successfully