[BETA] Report sync – Terminations

wbhk

payrollhubDatasyncTerminations

Beta. MVP for Payroll Hub API for Partners.

Webhook sent when a sync request is created for terminations data. Use the syncRequestId with Get sync report data and Update sync request records to complete the sync.

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

Payload

companyId

int64

required

The company ID.

type

string

enum

required

The webhook event type. Determines which report data set is being synced.

Allowed:

triggeredBy

string

required

The backend ID of the user or system that triggered the sync (e.g. employee ID or 'system').

triggeredAt

date-time

required

When the sync was triggered (ISO 8601).

expiringAt

date-time

When the sync request expires (ISO 8601). The partner should complete the sync before this time.

version

string

required

Webhook payload version (e.g. v2).

data

object

required

Headers

bob-signature

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

Loading…

400Invalid webhook payload