Skip to content
/
Employee

Employee
Webhook

Request

Security
X-Signature
Headers
X-Signaturestringrequired
Example:X-Signature: t=1492774577,v1=5257a869...
Bodyapplication/json

An employee was created, updated or deleted.

versionstring

The version of the event.

Example:"1"
idstring, (uuid)

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

Example:"c478966c-f927-411c-b919-179832d3d50c"
tenantIdstring, (uuid)

The unique identifier of the tenant the event belongs to.

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

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

Example:1698604061
typestring

The type of event that occurred.

Enum:"CREATE""UPDATE""DELETE"
categorystring

The category of the event.

Value:"ENTITY"
descriptionstring

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

Example:"employee@example.com added"
objectstring

The object that was created, updated or deleted.

Value:"EMPLOYEE"
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"
newobject or null(Employee)

The new state of the object. This is null when the event type is DELETE.

oldobject or null(Employee)

The previous state of the object. This is null when the event type is CREATE.

Payload
{
  "version": "1",
  "id": "c478966c-f927-411c-b919-179832d3d50c",
  "tenantId": "4f9d2e7a-1b3c-4d5e-8f6a-7c8b9d0e1f2a",
  "timestamp": 1698604061,
  "type": "CREATE",
  "category": "ENTITY",
  "description": "employee@example.com added",
  "object": "EMPLOYEE",
  "friendlyName": "Employee",
  "new": {
    "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
    "email": "john.hill@example.com",
    "firstName": "John",
    "lastName": "Hill",
    "department": "Security Engineering",
    "location": "New York",
    "licensed": true,
    "chatopsEnabled": true,
    "creationTimestamp": 1698669223
  },
  "old": {
    "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
    "email": "john.hill@example.com",
    "firstName": "John",
    "lastName": "Hill",
    "department": "Security Engineering",
    "location": "New York",
    "licensed": true,
    "chatopsEnabled": true,
    "creationTimestamp": 1698669223
  }
}

Responses

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