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 Name | Type | Description |
|---|---|---|
| order_id | string | Order identifier |
| order_number | string | Info passed into order_number for Order, nullable |
| employer_id | string | Unique Employer ID of Order |
| link_id | string | Identifier of Link associated to Task, nullable |
| product | string | Task related to specific product such as employment or income |
| data_source | string | Source of data. payroll, docs, insurance, financial_accounts, tax. |
| status | string | Order status following status lifecycle |
| user_id | string | Unique ID of user |
| template_id | string | Unique ID of template |
Tracking connection attempts for OrdersOrder status webhooks will only reflect successful connections. To listen for all connection attempts please refer to task status updated webhooks where the
tracking_infofield should match theemployer_idfrom Order.
New report ID after each completed connectionA new VOIE or VOA report ID will be generated after every additional connection is in 'completed' status