Webhook

Directory Group Deleted

​

Triggered when a directory group is deleted

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.group_deleted
{
  "spec_version": "1",
  "id": "evt_40650399597723966",
  "type": "organization.directory.group_deleted",
  "object": "DirectoryGroup",
  "occurred_at": "2024-10-07T10:25:26.289331747Z",
  "environment_id": "env_12205603854221623",
  "organization_id": "org_39802449573184223",
  "data": {
    "directory_id": "dir_39802485862301855",
    "display_name": "Admins",
    "dp_id": "7c66a173-79c6-4270-ac78-8f35a8121e0a",
    "id": "dirgroup_40072007005503806",
    "organization_id": "org_39802449573184223",
    "raw_attributes": {}
  },
  "display_name": "Directory Group Deleted"
}
No Body

Webhook received successfully