Webhook

Role Deleted

​

Triggered when a role 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 postrole.deleted
{
  "spec_version": "1",
  "id": "evt_3456789012",
  "type": "role.deleted",
  "object": "Role",
  "occurred_at": "2024-01-15T10:40:00.123456789Z",
  "environment_id": "env_1234567890",
  "data": {
    "description": "Updated viewer role with limited permissions",
    "display_name": "Viewer",
    "extends": "member",
    "id": "role_1234567890",
    "name": "viewer"
  },
  "display_name": "Role Deleted"
}
No Body

Webhook received successfully