Webhook

Directory User Updated

​

Triggered when a directory user is updated

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 postorganization.directory.user_updated
{
  "spec_version": "1",
  "id": "evt_53891546994442317",
  "type": "organization.directory.user_updated",
  "object": "DirectoryUser",
  "occurred_at": "2025-01-06T18:44:25.153954Z",
  "environment_id": "env_53814739859406915",
  "organization_id": "org_53879494091473415",
  "data": {
    "id": "diruser_12312312312312",
    "organization_id": "org_53879494091473415",
    "dp_id": "<scim_external_id>",
    "preferred_username": "<idp_user_name>",
    "email": "john.doe@example.com",
    "active": true,
    "name": "John Doe",
    "roles": [
      {
        "role_name": "billing_admin"
      }
    ],
    "groups": [
      {
        "id": "dirgroup_12312312312312",
        "name": "Group Name"
      }
    ],
    "given_name": "John",
    "family_name": "Doe",
    "nickname": "Jhonny boy",
    "picture": "https://image.com/profile.jpg",
    "phone_number": "1234567892",
    "address": {
      "postal_code": "64112",
      "state": "Missouri",
      "formatted": "123, Oxford Lane, Kansas City, Missouri, 64112"
    },
    "custom_attributes": {
      "attribute1": "value1",
      "attribute2": "value2"
    },
    "raw_attributes": {}
  },
  "display_name": "Directory User Updated"
}
No Body

Webhook received successfully