Pay cycle paid

wbhk

payrollPaycyclePaid

Beta. Sent when a US pay cycle is completed and paycheck data is
available for partner processing. Use data.payCycleId with
GetPayCycle and
ListPaychecks
to fetch the cycle window and paycheck rows, then submit deductions for the
next cycle via
CreateEmployeeDeduction
or
UpdateEmployeeDeduction.

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

Payload

companyId

int64

required

HiBob company identifier (numeric long).

type

string

enum

required

Event type discriminator. Always payroll.paycycle.paid for this webhook.

Allowed:

triggeredBy

string

required

Backend identifier of the user or system that triggered the event
(returned as a string to avoid loss of precision).

triggeredAt

string

required

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$

When the event occurred, in ISO 8601 date-time form with Z suffix
(e.g. "2026-02-15T09:00:00Z").

version

string

required

Webhook payload schema version. Currently always "v2". The payload
version is independent of the partner API version (this API is v1).

data

object

required

Pay cycle that was paid.

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