[BETA] - Report sync – New hires

webhook

payrollhubDatasyncNewhires

Webhook when a new-hires sync request is created.

Beta. Webhook sent when a sync request is created for new hires data.
Use syncRequestId from the payload with Get sync report data, then report
status via Update sync request records.

Every webhook request carries a bob-signature header — verify it before
processing. See HiBob's
webhook signature verification guide.

Payload

Payload sent when a Payroll Hub report sync webhook is delivered.

companyId

int64

required

The company ID.

type

string

enum

required

Webhook event type. Determines which report data set is being synced.

Allowed:

triggeredBy

string

required

Backend ID of the user or system that triggered the sync.

triggeredAt

date-time

required

When the sync was triggered (ISO 8601).

expiringAt

date-time | null

When the sync request expires (ISO 8601). Complete the sync before this time.

version

string

required

Webhook payload version (e.g. v2).

data

object

required

Sync request reference.

Headers

bob-signature

string

required

Base64-encoded signature sent with each webhook request. Use it to verify that the request came from Bob.

Responses

200

Webhook received successfully

400Invalid webhook payload