Retirement Partners Webhooks

Pay cycle paid

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.

postWebhookpayrollPaycyclePaid

Headers

bob-signaturestring required

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

Payload

companyIdinteger required

HiBob company identifier (numeric long).

type'payroll.paycycle.paid' required
triggeredBystring required

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

triggeredAtstring required

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

versionstring required

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

Response

Webhook received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.