Employee removed from group

Employee removed from group
Webhook

Request

An admin user removed an employee from a group.

Security

X-Signature

X-Signaturestringrequired

Example:X-Signature: t=1492774577,v1=5257a869...

Bodyapplication/json

versionstringrequired

The version of the event.

Example:"1"

idstring, (uuid)required

The unique identifier for the event. This can be used as an idempotency key.

Example:"c478966c-f927-411c-b919-179832d3d50c"

tenantIdstring, (uuid)required

The unique identifier of the tenant the event belongs to.

Example:"4f9d2e7a-1b3c-4d5e-8f6a-7c8b9d0e1f2a"

timestampintegerrequired

When the event occurred, formatted as a UNIX timestamp (in seconds).

Example:1698604061

categorystringrequired

The category of the event.

Value:"AUDIT"

objectstringrequired

The object that was created.

Value:"EMPLOYEE_REMOVED_FROM_GROUP"

actorobject(Admin Audit Log Actor)required

This object contains information about the user that performed the action triggering the audit log.

newobjectrequired

tenantMetadataobject(Tenant Metadata)

Key/value metadata set by the partner that manages this tenant. Only present for tenants managed by a partner. When a partner manages the tenant but has set no metadata, it is present as an empty object rather than omitted or null. A partner may set at most 10 entries, with keys up to 40 characters and values up to 256 characters.

Example:

{
  "customerRef": "ACME-001",
  "region": "emea"
}

descriptionstring

The description of the event. Note: this is subject to change and should not be used to match on this object.

Example:"user@example.com removed an employee from the group Engineers"

friendlyNamestring

The friendly name of this object. Note: this is subject to change and should not be used to match on this object.

Example:"Employee removed from group"

POST

employee-removed-from-group

Payload

{
  "version": "1",
  "id": "c478966c-f927-411c-b919-179832d3d50c",
  "tenantId": "4f9d2e7a-1b3c-4d5e-8f6a-7c8b9d0e1f2a",
  "tenantMetadata": {
    "customerRef": "ACME-001",
    "region": "emea"
  },
  "timestamp": 1698604061,
  "category": "AUDIT",
  "description": "user@example.com removed an employee from the group Engineers",
  "object": "EMPLOYEE_REMOVED_FROM_GROUP",
  "friendlyName": "Employee removed from group",
  "actor": {
    "source": "UI",
    "email": "string",
    "sourceIpAddress": "string",
    "userAgent": "string",
    "role": "OWNER"
  },
  "new": {
    "group": "string",
    "employee_id": "string"
  }
}

Responses

Return any 2XX status to indicate that the data was received successfully