Webhooks

View more information about Order webhook responses.

Order status change

The sample webhook payload below is for order-status-updated.

{
   "webhook_id":"00d265a8919447fb8bfc9da5a6f10fbd",
   "order_id":"abef776738194af389870fa20219ddf1",
   "order_number":"4138538",
   "employer_id":"31e2fdc5bf0c42d4bd2eb16f49066b0d",
   "product":"income",
   "data_source":null,
   "link_id":null,
   "event_type":"order-status-updated",
   "event_created_at":"2022-08-24T13:54:00.798978Z",
   "updated_at":"2022-08-24T13:54:00.799000+00:00",
   "status":"expired",
   "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc",
   "template_id": null
}

The order-status-updated event occurs when the status of Orders changes. Receiving an order-status-updated event with a status of completed shows successfully processing and payroll accounts are linked.

Field NameTypeDescription
order_idstringOrder identifier
order_numberstringInfo passed into order_number for Order, nullable
employer_idstringUnique Employer ID of Order
link_idstringIdentifier of Link associated to Task, nullable
productstringTask related to specific product such as employment or income
data_sourcestringSource of data. payroll, docs, insurance, financial_accounts, tax.
statusstringOrder status following status lifecycle
user_idstringUnique ID of user
template_idstringUnique ID of template