Webhooks List
| Webhook Name | Event type | Description | Payload |
|---|---|---|---|
| Orders webhook | order_status_change | An order status has changed. | Order status change payload |
Order status change payload
{
"event_id": "1234567890",
"event": {
"name": "order_status_change",
"changed_field": "status",
"old_status": "Active",
"new_status": "Cancelled"
},
"order": {
"id": 1,
"uuid": "a746224f-d569-4aba-a271-4532259aba42",
"service": "incorporation-package",
"status": "Cancelled",
"processing_status": "Under Review",
"submit_date": "2025-08-07",
"first_name": "Joe",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "314545456",
"consent_sms": false,
"affirmation_full_name": null,
"affirmation_title": null,
"created_at": "2025-08-07 08:49:37",
"updated_at": "2025-08-07 08:49:37",
"business_data": {
"name": "My biz",
"type": 1,
"type_name": "LLC",
"designator": "Inc",
"formation_state": "CA",
"formation_date": null,
"category": "541211",
"category_name": "Accounting",
"alternative_name": null,
"description": null,
"address": null,
"city": null,
"state": null,
"zip": null,
"address_complement": null,
"managed_by": null,
"par_value": null,
"number_of_shares": null,
"business_number": "456s4df"
},
"contact": {
"name": "Contact1",
"address": "dsfsadfasd"
},
"managers_data": [
{
"title": "Member",
"full_name": "sdfsadf",
"address": "some address",
"city": "acity",
"state": "CA",
"zip": "456453",
"address_complement": "office 101",
"is_company": false
},
...
],
"registered_agent_provider": "Other",
"registered_agent": {
"name": "some name",
"address": "",
"city": "",
"state": null,
"zip": "",
"phone": "",
"email": "email"
},
"order_items": [
{
"submitted_at": "2025-08-07 08:49:37",
"type": "sale",
"items": [
"SF_1180_SG_0",
"SF_1014_SG_0",
"SF_1025_SG_0",
"SF_1031_SG_0",
"SF_1036_SG_0",
"SF_1041_SG_0",
"SF_1042_SG_0",
"SF_1043_SG_0"
]
},
...
],
"required_actions": {
"rejections": [
{
"id": 220742,
"field": "business_name",
"reason": "Your business name is too similar to another company already in business. Please provide us with a new business name to submit to the state.",
"message": "Use rejection answer EP to answer rejection."
},
{
"id": 220743,
"field": "state_specific.veteran_verification_document",
"reason": "A required document is missing: Upload veteran Verification Document",
"message": "Upload the requested document via the documents EP to answer this rejection"
}
],
"questionnaires": [],
"alerts": []
}
}
}
Note: The order details are the same as the Get Order response.
Note: Partner-defined input field values are merged into the
orderobject by key prefix — e.g.business_data.business_numberis nested insidebusiness_data, while a prefix with no matching object (e.g.contact.name) creates that object on the order. Keys without a dot are returned as flat fields on the order.Required files: When a service requires a supporting file (a
documentinput field flagged required) and it is missing after order creation, the order moves toAction Requiredand this webhook fires withnew_status: "Action Required". The missing document appears as an entry underrequired_actions.rejections, whosereasonnames the document. Upload the file viaPOST {baseUrl}/orders/{order_uuid}/documentswithfield_keyset to the document field'skey; once every required file is provided the order leavesAction Requiredand this webhook fires again. See Upload Order Documents.