API Reference
Become a partner

Employee joined

wbhk
employeeJoined

Triggered when an employee is granted access, once the corresponding lifecycle entry becomes effective.

Lifecycle events are triggered automatically at midnight on the effective date of the lifecycle table entry (according to the site's timezone).

In the right panel, open Examples and select Payload Example to see a real payload.

Payload
number
required

The company ID

string
enum
required

Event type for employee joined (access granted)

Allowed:
string
required

The backend-id of the employee that triggered the event, or 'system' for system-triggered events

string
required

The timestamp when the event occurred (ISO 8601-style string)

string
required

The webhook version (e.g., v2)

data
object
required

Data payload for lifecycle events (joined, left, activated, inactivated, temporaryLeave)

Headers
string
required

Base64-encoded signature sent with each webhook request. Use it to verify that the request came from Bob. To verify webhook authenticity, see How does Bob calculate the signature.

Responses
200

Webhook received successfully

Updated 2 months ago 

LoadingLoading…

Updated 2 months ago