Webhooks
In this guide, we will look at how to register and consume webhooks to integrate your app with CollateralXP. With webhooks, your app can know when something happens in CollateralXP, such as someone assigns you to an order or adds a note for you.
Registering webhooks
The CollateralXP team which is responsible for your setup, will ask you in the proper time, to inform your webhook URL.
Then, whenever something of interest happens in the app, your webhooks is fired off by CollateralXP. In the next section, we'll look at how to consume webhooks.
Consuming webhooks
When your app receives a webhook request from CollateralXP, check the event attribute to see what event caused it.
Then you can check the data attribute to see the event payload CollateralXP has sent to you.
Example webhook payload
{
"event": "ordering::workflow::order_workflow::assigned",
"data": {
"vendor_id": "186d5e35-df0d-4611-aa77-f5942c9788f8",
"product_ids": [
"9e777f28-c2db-4e24-938e-87a51dcd7de3"
],
"assignment_accepted_at": null
"vendor_phone": "(111) 000-0000",
// ...
}
}
In the example above, the order was assigned, and the payload event is a ordering::workflow::order_workflow::assigned.
Events
Order added
When a new order is placed
Example webhook payload
{
"event": "ordering::workflow::order_workflow::added",
"data": {
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"state_id": "c676e59a-aaa5-419f-a797-f4ffc2e4c9df",
"county_id": "b87b11cb-fa1e-4c2e-90ce-353057d423f3",
"product_ids": ["41efc469-eb78-4063-b63d-dfe57ddba976"],
"client_name": "ABC Bank",
"lender_name": "ABC Bank",
"company_name": "eValuation ZONE, Inc.",
"borrower_name": "John Doe",
"borrower_email": "john.doe@email.com",
"co_borrower_name": null,
"entity_name": "",
"full_address": "6105 W Montrose Ave, Chicago, IL 60634",
"address_one": "6105 W Montrose Ave",
"city": "Chicago",
"zip": "60634",
"lender_address": "6103 W Montrose, Chicago, IL 61634",
"latitude": "-90.1234567",
"longitude": "40.1234567",
"loan_number": "5436456",
"file_number": "EVAL-00023969",
"client_file_number": "",
"transaction_type": "refinance",
"payment_method": "invoice_client",
"contract_price": null,
"contract_date": null,
"closing_date": null,
"due_date": null,
"concession_amount": null,
"fha_case_number": null,
"passthrough_model": false,
"processors_emails": [
"kathy.fake+abcbank@example.com",
"chicago.fake@example.com"
],
"loan_officer_emails": ["kpolak.fake@example.com"],
"order_files": [],
"product_fees": [],
"vendor_fees": [],
"report_logo_resource": {
"id": 3110621,
"name": "logo",
"record_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"record_type": "Ordering::Company",
"blob_id": 2228642,
"created_at": "2026-02-10T15:50:55.123-03:00"
},
"created_at": "2026-02-12T11:01:57.000-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"email": "john.doe@email.com",
"emails": ["john.doe@email.com"],
"phone": null,
"phones": []
}
}
}
}
Order accepted
When the order was accepted
Example webhook payload
{
"event": "ordering::workflow::order_workflow::accepted",
"data": {
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"product_ids": ["41efc469-eb78-4063-b63d-dfe57ddba976"],
"products": ["CONV CONDO (FNMA 1073)"],
"lender_name": "ABC Bank",
"company_name": "eValuation ZONE, Inc.",
"borrower_email": "john.doe@email.com",
"borrower_phone": null,
"poc_phone": "(555) 000-0001",
"processors_emails": [
"kathy.fake+abcbank@example.com",
"chicago.fake@example.com"
],
"loan_officer_emails": ["kpolak.fake@example.com"],
"loan_number": "5436456",
"file_number": "EVAL-00023969",
"due_date": "2026-03-13T20:59:59.000-03:00",
"passthrough_model": false,
"address_resource": {
"address_one": "6105 W Montrose Ave",
"address_two": "",
"city": "Chicago",
"state": "Illinois",
"zip": "60634",
"county": "Cook County"
},
"created_at": "2026-02-12T11:01:57.000-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"email": "john.doe@email.com",
"emails": ["john.doe@email.com"],
"phone": null,
"phones": []
}
}
}
}
Assigned
The order was assigned to a vendor.
Example webhook payload
{
"event": "ordering::workflow::order_workflow::assigned",
"data": {
"vendor_id": "6e9aadc1-697f-42e5-b6e2-8f0ccb9103a6",
"user_id": "fccbc598-cb8d-4b76-839b-3c2a16fb40d4",
"product_ids": ["41efc469-eb78-4063-b63d-dfe57ddba976"],
"assignment_accepted_at": null,
"vendor_name": "Vendor Example",
"vendor_phone": "(555) 000-0002",
"vendor_license_number": "123456789",
"vendor_license_type": "certified_residential",
"vendor_license_state": "IL",
"vendor_license_expires_at": "2027-09-29T21:00:00.000-03:00",
"auto_reject_hours": 12,
"address_resource": {
"address_one": "6105 W Montrose Ave",
"address_two": "",
"city": "Chicago",
"state": "Illinois",
"zip": "60634",
"county": "Cook County"
},
"address": "6105 W Montrose Ave, Chicago, IL 60634",
"borrower_email": "john.doe@email.com",
"processors_emails": [
"kathy.fake+abcbank@example.com",
"chicago.fake@example.com"
],
"loan_officer_emails": ["kpolak.fake@example.com"],
"fees": [
{
"fee": 300,
"product_id": "41efc469-eb78-4063-b63d-dfe57ddba976"
}
],
"vendor_license_resource": {
"filename": "License 2025-27.pdf",
"key": "n8obsf73e2niztdg46z5f99q680d",
"content_type": "application/pdf",
"byte_size": 489696,
"checksum": "TcKMcH7IHRrloo3rXdzebA==",
"link": "http://localhost:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTkwNzAwMSwicHVyIjoiYmxvYl9pZCJ9fQ==--cbd5f8d36bd5345f42599dc13e44fec54fe8d9ca/License%202025-27.pdf",
"submission_file": false
},
"vendor_insurance_resource": {
"filename": "Declaration Page and Certificate.PDF",
"key": "hro0hkeybb4c9asu8mrg7sqia7ah",
"content_type": "application/pdf",
"byte_size": 284912,
"checksum": "ocuC4fo7+Mlo10RDo11yrQ==",
"link": "http://localhost:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTgxNjczNywicHVyIjoiYmxvYl9pZCJ9fQ==--63f005851b9ae77db9450ac0281685a1eb50318c/Declaration%20Page%20and%20Certificate.PDF",
"submission_file": false
},
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2026-02-12T11:01:57.000-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"email": "john.doe@email.com",
"emails": ["john.doe@email.com"],
"phone": null,
"phones": []
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Assignment accepted
Vendor has accepted the assignment
Example webhook payload
{
"event": "ordering::workflow::order_workflow::assignment_accepted",
"data": {
"vendor_id": "6e9aadc1-697f-42e5-b6e2-8f0ccb9103a6",
"user_id": "fccbc598-cb8d-4b76-839b-3c2a16fb40d4",
"vendor_email": "mail@email.com",
"vendor_name": "Vendor Example",
"vendor_phone": "(555) 000-0002",
"vendor_license_number": "123456789",
"vendor_license_type": "certified_residential",
"vendor_license_state": "IL",
"vendor_license_expires_at": "2027-09-29T21:00:00.000-03:00",
"product_ids": ["1dde8b57-c96e-421d-bfa7-765a5bb6a562"],
"assignment_accepted_at": "2026-02-12T17:50:46.100-03:00",
"auto_accepted": false,
"passthrough_model": false,
"passthrough_integration": false,
"address_resource": {
"address_one": "6309 W Grace St",
"address_two": "",
"city": "Chicago",
"state": "Illinois",
"zip": "60634",
"county": "Cook County"
},
"address": "6309 W Grace St, Chicago, IL 60634",
"borrower_email": null,
"processors_emails": [
"kathy.fake+abcbank@example.com",
"chicago.fake@example.com"
],
"lender_name": "ABC Bank",
"loan_number": "123123",
"file_number": "EVAL-00022889",
"loan_officer_emails": ["kpolak.fake@example.com"],
"vendor_license_resource": {
"filename": "License 2025-27.pdf",
"key": "n8obsf73e2niztdg46z5f99q680d",
"content_type": "application/pdf",
"byte_size": 489696,
"checksum": "TcKMcH7IHRrloo3rXdzebA==",
"link": "http://app.collateralxp.com/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTkwNzAwMSwicHVyIjoiYmxvYl9pZCJ9fQ==--cbd5f8d36bd5345f42599dc13e44fec54fe8d9ca/License%202025-27.pdf",
"submission_file": false
},
"vendor_insurance_resource": {
"filename": "Declaration Page and Certificate.PDF",
"key": "hro0hkeybb4c9asu8mrg7sqia7ah",
"content_type": "application/pdf",
"byte_size": 284912,
"checksum": "ocuC4fo7+Mlo10RDo11yrQ==",
"link": "http://app.collateralxp.com/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTgxNjczNywicHVyIjoiYmxvYl9pZCJ9fQ==--63f005851b9ae77db9450ac0281685a1eb50318c/Declaration%20Page%20and%20Certificate.PDF",
"submission_file": false
},
"vendor_license_fha_approved": null,
"order_id": "875dd584-2485-4bff-b803-35fe4178e8a1",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2026-01-12T10:40:15.000-03:00",
"contacts": {
"borrower": {
"name": "test t test",
"email": null,
"emails": [],
"phone": null,
"phones": []
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Assignment conditions approved
When order assignment conditions were approved
Example webhook payload
{
"event": "ordering::workflow::order_workflow::assignment_condition_approved",
"data": {
"vendor_id": "6e9aadc1-697f-42e5-b6e2-8f0ccb9103a6",
"user_id": "fccbc598-cb8d-4b76-839b-3c2a16fb40d4",
"vendor_email": "mail@email.com",
"vendor_name": "Vendor Example",
"vendor_phone": "(555) 000-0002",
"vendor_license_number": "123456789",
"vendor_license_type": "certified_residential",
"vendor_license_state": "IL",
"vendor_license_expires_at": "2027-09-29T21:00:00.000-03:00",
"loan_officer_emails": ["kpolak.fake@example.com"],
"passthrough_model": false,
"passthrough_integration": false,
"product_ids": ["41efc469-eb78-4063-b63d-dfe57ddba976"],
"assignment_accepted_at": "2026-02-12T13:00:24.469-03:00",
"address_resource": {
"address_one": "6105 W Montrose Ave",
"address_two": "",
"city": "Chicago",
"state": "Illinois",
"zip": "60634",
"county": "Cook County"
},
"address": "6105 W Montrose Ave, Chicago, IL 60634",
"borrower_email": "john.doe@email.com",
"processors_emails": [
"kathy.fake+abcbank@example.com",
"chicago.fake@example.com"
],
"lender_name": "ABC Bank",
"loan_number": "5436456",
"file_number": "EVAL-00023969",
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2026-02-12T11:01:57.000-03:00",
"vendor_license_resource": {
"filename": "License 2025-27.pdf",
"key": "n8obsf73e2niztdg46z5f99q680d",
"content_type": "application/pdf",
"byte_size": 489696,
"checksum": "TcKMcH7IHRrloo3rXdzebA==",
"link": "http://localhost:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTkwNzAwMSwicHVyIjoiYmxvYl9pZCJ9fQ==--cbd5f8d36bd5345f42599dc13e44fec54fe8d9ca/License%202025-27.pdf",
"submission_file": false
},
"vendor_insurance_resource": {
"filename": "Declaration Page and Certificate.PDF",
"key": "hro0hkeybb4c9asu8mrg7sqia7ah",
"content_type": "application/pdf",
"byte_size": 284912,
"checksum": "ocuC4fo7+Mlo10RDo11yrQ==",
"link": "http://localhost:3000/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZGF0YSI6MTgxNjczNywicHVyIjoiYmxvYl9pZCJ9fQ==--63f005851b9ae77db9450ac0281685a1eb50318c/Declaration%20Page%20and%20Certificate.PDF",
"submission_file": false
},
"contacts": {
"borrower": {
"name": "John Doe",
"email": "john.doe@email.com",
"emails": ["john.doe@email.com"],
"phone": null,
"phones": []
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Assignment conditions rejected
When order assignment conditions were rejected
Example webhook payload
{
"event": "ordering::workflow::order_workflow::assignment_condition_rejected",
"data": {
"vendor_id": "6e9aadc1-697f-42e5-b6e2-8f0ccb9103a6",
"user_id": "fccbc598-cb8d-4b76-839b-3c2a16fb40d4",
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2026-02-12T11:01:57.000-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"email": "john.doe@email.com",
"emails": ["john.doe@email.com"],
"phone": null,
"phones": []
}
}
}
}
Inspection scheduled
The inspection has been scheduled
Example webhook payload
{
"event": "ordering::workflow::assignment_workflow::inspection_scheduled",
"data": {
"inspection_scheduled_at": "2026-02-12T12:34:00.000-03:00",
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2026-02-12T11:01:57.000-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"email": "john.doe@email.com",
"emails": ["john.doe@email.com"],
"phone": null,
"phones": []
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Address Set
When the order address is updated.
Example webhook payload
{
"event": "ordering::order_setup::address_set",
"data": {
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"full_address": "6105 W Montrose Ave, Chicago, IL 60634",
"street": "6105 W Montrose Ave",
"city": "Chicago",
"state": "IL",
"county": "Cook County",
"unit": "",
"zip_code": "60634",
"latitude": "-90.1234567",
"longitude": "40.1234567",
"user_id": "fccbc598-cb8d-4b76-839b-3c2a16fb40d4"
}
}
Inspection completed
The inspection has been completed
Example webhook payload
{
"event": "ordering::workflow::assignment_workflow::inspection_completed",
"data": {
"inspection_completed_at": "2026-02-12T14:24:09.000-03:00",
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2026-02-12T11:01:57.000-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"email": "john.doe@email.com",
"emails": ["john.doe@email.com"],
"phone": null,
"phones": []
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Submission requested
Submission files were requested
Example webhook payload
{
"event": "ordering::workflow::assignment_workflow::submitted",
"data": {
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"company_name": "eValuation ZONE, Inc.",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"loan_type": "conventional",
"loan_number": "5436456",
"fha_case_number": null,
"transaction_type": "refinance",
"products": ["CONV CONDO (FNMA 1073)"],
"appraised_value": "0.0",
"due_date": "2026-03-13T20:59:59.000-03:00",
"passthrough_integration": false,
"files": [
{
"file_id": "4cc0095c-f869-4fd1-a742-b78b1a2d9428",
"product_id": "41efc469-eb78-4063-b63d-dfe57ddba976",
"file_type": "appraisal_xml",
"attachment_resource": {
"filename": "1004.xml",
"key": "yxbw8lx3r8h9v235a3akw2li7jay",
"content_type": "text/xml",
"byte_size": 3534289,
"checksum": "4zYSCdRVCkp3EUw9TDq47g==",
"link": "http://app.collateralxp.com/mismo.xml",
"submission_file": true
}
}
],
"created_at": "2026-02-12T11:01:57.000-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"email": "john.doe@email.com",
"emails": ["john.doe@email.com"],
"phone": null,
"phones": []
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Revision requested
When the order has a revision requested
Example webhook payload
{
"event": "ordering::workflow::client_request_workflow::revision_asked",
"data": {
"content": "tedst",
"order_id": "38a79d48-8b0d-4e47-8d31-75fa89765ab8c",
"client_id": "77cb42f8-8d31-4466-be83-30b29ba06253",
"lender_id": "77cb42f8-8d31-4466-be83-30b29ba06253",
"created_at": "2023-04-14T15:19:21.752-03:00",
"company_name": "Abc Bank",
"contacts": {
"borrower": {
"name": "Adam Borrower",
"email": "borrower.fake@example.com",
"phone": "(133) 999-0000"
},
"vendor": {
"name": "John Doe",
"email": "john.fake@example.com",
"phone": "(123) 000-0000",
"license_number": "111111111"
}
}
}
}
QA revision requested
When the order has a QA revision asked
Example webhook payload
{
"event": "ordering::workflow::quality_assurance_workflow::revision_asked",
"data": {
"content": "<div>requesting QA review<br><br></div>",
"user_id": "fccbc598-cb8d-4b76-839b-3c2a16fb40d4",
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2026-02-12T11:01:57.000-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"emails": ["john.doe@email.com"],
"email": "john.doe@email.com",
"phones": [],
"phone": null
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Revision requested from client
When the order has a revision requested from client
Example webhook payload
{
"event": "ordering::workflow::client_request_workflow::revision_asked_from_client",
"data": {
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"company_name": "eValuation ZONE, Inc.",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"content": "<div>test client revision request</div>",
"appraised_value": "415000.0",
"due_date": "2026-03-13T20:59:59.000-03:00",
"created_at": "2026-02-12T11:01:57.000-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"email": "john.doe@email.com",
"emails": ["john.doe@email.com"],
"phone": null,
"phones": []
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Completed
Order has been completed
Example webhook payload
{
"event": "ordering::workflow::quality_assurance_workflow::completed",
"data": {
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"company_name": "eValuation ZONE, Inc.",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"user_id": "fccbc598-cb8d-4b76-839b-3c2a16fb40d4",
"appraised_value": "415000.0",
"appraisal_effective_date": "2021-01-07",
"appraisal_delivering_submission_id": null,
"completed_date": "2026-02-12",
"due_date": "2026-03-13T20:59:59.000-03:00",
"product_ids": ["41efc469-eb78-4063-b63d-dfe57ddba976"],
"products": ["CONV CONDO (FNMA 1073)"],
"service_types": ["residential_appraisals"],
"freddie_mac_score": null,
"fannie_mae_score": null,
"env_required": false,
"files": [
{
"product_id": null,
"file_type": "appraiser_invoice",
"attachment_resource": {
"filename": "invoice.pdf",
"key": "x4iw7au1iixkyyzf9q7jjw5wsv7h",
"content_type": "application/pdf",
"byte_size": 70609,
"checksum": "NuAenUSaIThX03zRfo+qqw==",
"link": "http://localhost:3200/rails/active_storage/blobs/redirect/...",
"submission_file": true
}
},
{
"product_id": "41efc469-eb78-4063-b63d-dfe57ddba976",
"file_type": "appraisal_xml",
"attachment_resource": {
"filename": "1004.xml",
"key": "f4bnpqtj71wt95vlnclmhc6z17sh",
"content_type": "text/xml",
"byte_size": 3534289,
"checksum": "4zYSCdRVCkp3EUw9TDq47g==",
"link": "http://localhost:3200/rails/active_storage/blobs/redirect/...",
"submission_file": true
}
},
{
"product_id": null,
"file_type": "certificate_of_compliance",
"attachment_resource": {
"filename": "certificate_of_compliance.pdf",
"key": "cqrh3vevqs5d7pmea21ywndpdxks",
"content_type": "application/pdf",
"byte_size": 69446,
"checksum": "PDWv9Y7H3nBcH9cORaMjKg==",
"link": "http://localhost:3200/rails/active_storage/blobs/redirect/...",
"submission_file": true
}
},
{
"product_id": null,
"file_type": "appraisal_pdf",
"attachment_resource": {
"filename": "EVAL-00023969.pdf",
"key": "3c9b86ybjie6c2u8kuwvr6a5y42t",
"content_type": "application/pdf",
"byte_size": 2523559,
"checksum": "l9GiXNnReHkVyTP6n8CWAg==",
"link": "http://localhost:3200/rails/active_storage/blobs/redirect/...",
"submission_file": true
}
}
],
"parsed_mismo": {
"header": {
"appraisal_form_type": "FNM1004",
"appraisal_purpose_type": "Purchase",
"report_title_description": "Uniform Residential Appraisal Report",
"appraiser_file_identifier": "20397344",
"appraiser_report_signed_date": "2021-01-11"
},
"subject": {
"full_address": "6123 Farrington Rd, Chapel Hill Durham, NC 27517",
"street_address": "6123 Farrington Rd",
"city": "Chapel Hill",
"state": "NC",
"postal_code": "27517",
"county": "Durham",
"property_rights": "FeeSimple",
"current_occupancy_type": "Vacant",
"property_owner_name": "CalAtlantic Group INC"
},
"improvements": {
"year_built": 2021,
"building_status_type": "UnderConstruction",
"attachment_type": "Detached",
"number_of_stories": "2",
"total_bedroom_count": "4",
"total_bathroom_count": "2.1",
"total_room_count": "8",
"square_feet_count": "1056",
"gross_living_area_square_feet_count": "2737",
"garage_parking_spaces_count": "3",
"heating_type": "ForcedWarmAir",
"cooling_centralized_indicator": "Y",
"gse_overall_condition_type": "C1"
},
"reconciliation": {
"property_appraised_value_amount": "415000",
"value_indicated_by_sales_comparison_approach_amount": "415000",
"value_indicated_by_cost_approach_amount": "430690"
}
},
"created_at": "2026-02-12T11:01:57.000-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"email": "john.doe@email.com",
"emails": ["john.doe@email.com"],
"phone": null,
"phones": []
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Fulfilled
The order was fulfilled.
Example webhook payload
{
"event": "ordering::workflow::client_request_workflow::fulfilled",
"data": {
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"company_name": "eValuation ZONE, Inc.",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"vendor_id": "6e9aadc1-697f-42e5-b6e2-8f0ccb9103a6",
"appraised_value": "415000.0",
"appraisal_effective_date": "2021-01-07",
"appraisal_delivering_submission_id": null,
"freddie_mac_score": null,
"fannie_mae_score": null,
"product_ids": ["41efc469-eb78-4063-b63d-dfe57ddba976"],
"products": ["CONV CONDO (FNMA 1073)"],
"due_date": "2026-03-13T20:59:59.000-03:00",
"created_at": "2026-02-12T11:01:57.000-03:00",
"parsed_mismo": {
"header": {
"appraisal_form_type": "FNM1004",
"appraisal_purpose_type": "Purchase",
"report_title_description": "Uniform Residential Appraisal Report",
"appraiser_file_identifier": "20397344",
"appraiser_report_signed_date": "2021-01-11"
},
"subject": {
"full_address": "6123 Farrington Rd, Chapel Hill Durham, NC 27517",
"street_address": "6123 Farrington Rd",
"city": "Chapel Hill",
"state": "NC",
"postal_code": "27517",
"county": "Durham",
"property_rights": "FeeSimple",
"current_occupancy_type": "Vacant",
"property_owner_name": "CalAtlantic Group INC"
},
"improvements": {
"year_built": 2021,
"building_status_type": "UnderConstruction",
"attachment_type": "Detached",
"number_of_stories": "2",
"total_bedroom_count": "4",
"total_bathroom_count": "2.1",
"total_room_count": "8",
"gross_living_area_square_feet_count": "2737",
"garage_parking_spaces_count": "3",
"heating_type": "ForcedWarmAir",
"cooling_centralized_indicator": "Y",
"gse_overall_condition_type": "C1"
},
"reconciliation": {
"property_appraised_value_amount": "415000",
"value_indicated_by_sales_comparison_approach_amount": "415000",
"value_indicated_by_cost_approach_amount": "430690"
}
},
"contacts": {
"borrower": {
"name": "John Doe",
"email": "john.doe@email.com",
"emails": ["john.doe@email.com"],
"phone": null,
"phones": []
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Note added
The note was added to the order.
Example webhook payload
{
"event": "ordering::note_added",
"data": {
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"note_id": "6aea1385-5f69-434a-b179-04726faca6f0",
"author_name": "Mauricio Lima",
"author_role": "staff",
"author_email": "mauricio.fake@example.com",
"type": "all_roles",
"subject": null,
"content": " <br> adding one more note with attachment <br> <br>",
"content_plain_text": "adding one more note with attachment",
"note_action": null,
"note_added_at": "2026-02-12T12:33:18.000-03:00",
"status_slug": "pending_assignment",
"from_workflow": false,
"important": false,
"notify_as_sms": false,
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"user_id": "fccbc598-cb8d-4b76-839b-3c2a16fb40d4",
"passthrough_model": false,
"attachment_resources": [
{
"filename": "logo-test.svg",
"key": "zg09hc854uqyzfi3t65b9e1dp22k",
"content_type": "image/svg+xml",
"byte_size": 8568,
"checksum": "GPRgd7clhrXGgnHB3yAIKQ==",
"link": "http://app.collateralxp.com/logo-test.svg"
}
]
}
}
Lifecycle note added
Notes generated by the system
Example webhook payload
{
"event": "ordering::lifecycle_note_added",
"data": {
"order_id": "72636696-d58c-425b-884b-bd771f1e1d3d",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"type": "all_roles",
"content": "In review status updated by System.",
"note_id": "419be376-2a67-49e4-a17a-bfd2e77d5692",
"subject": null,
"author_name": "System",
"author_role": null,
"attachment_sgids": [],
"from_workflow": false
}
}
Note added (From integration)
The note was added to the order by some integration. BE CAREFUL WITH THIS EVENT, AS IT COULD EASILY CREATE CYCLIC NOTES CREATION IF THE NOTE CAME FROM YOUR INTEGRATION.
Example webhook payload
{
"event": "ordering::note_added_from_integration",
"data": {
"order_id": "38a79d48-8b0d-4e47-8d31-75fa89765ab8c",
"author_name": "Andre Pereira",
"subject": null,
"from_workflow": false,
"client_id": "77cb42f8-8d31-4466-be83-30b29ba06253",
"type": "vendor",
"note_id": "c3c33d69-473a-4b05-b8df-a895394a342f",
"content"=>" <br> <br> this is a note test <br> <br><br> <br>",
"content_plain_text"=>"\n this is a note test \n ",
"author_role": "staff",
"important": false,
"status_slug": "pending_assignment",
"attachment_sgids": [
{
"filename": "file.jpg",
"key": "h1clz0cne3vc9hywtgpxn929rz60",
"content_type": "image/jpeg",
"byte_size": 108410,
"checksum": "bSjL1dAw2aQq85H4/RiF0Q==",
"link": "http://app.collateralxp.com/id.jpg",
"submission_file": false
}
]
}
}
File added
A file was added to the order
Example webhook payload
{
"event": "ordering::file_added",
"data": {
"file_id": "a06295df-c9f4-4bdc-9460-8c00674a5ceb",
"file_type": "appraiser_invoice",
"filename": "invoice.pdf",
"passthrough_model": false,
"source": null,
"user_id": null,
"user_type": null,
"file_client_user": null,
"file_staff_user": null,
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"attachment_resource": {
"filename": "invoice.pdf",
"key": "szw94fv5p8ihc3oc6csqgb86dioz",
"content_type": "application/pdf",
"byte_size": 70603,
"checksum": "Mf4Q6inGjMGLPyaUFrjLYQ==",
"link": "http://app.collateralxp.com/invoice.pdf",
"submission_file": true
}
}
}
Holded (it will be renamed to Held soon)
When something happens and all work should be paused, until the order is resumed.
Example webhook payload
{
"event": "ordering::workflow::holded",
"data": {
"reason": "test hold",
"vendor_id": "6e9aadc1-697f-42e5-b6e2-8f0ccb9103a6",
"from_integration": false,
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2026-02-12T11:01:57.436-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"emails": ["john.doe@email.com"],
"email": "john.doe@email.com",
"phones": [],
"phone": null
},
"vendor": {
"name": "Vendor Example",
"email": "mail.fake@example.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Resumed
When the order is resumed from a hold status.
Example webhook payload
{
"event": "ordering::workflow::resumed",
"data": {
"vendor_id": "6e9aadc1-697f-42e5-b6e2-8f0ccb9103a6",
"from_integration": false,
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2026-02-12T11:01:57.436-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"emails": ["john.doe@email.com"],
"email": "john.doe@email.com",
"phones": [],
"phone": null
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Point of Contact Updated
Example webhook payload
{
"event": "ordering::order_setup::point_of_contact_updated",
"data": {
"party_id": "a295ade7-6cd8-4b79-8004-f8c502d6758f",
"party_name": "Mary Doe",
"phones": ["555-000-0003"],
"emails": ["mary.fake@example.com"],
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2026-02-12T11:01:57.436-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"emails": ["john.doe@email.com"],
"email": "john.doe@email.com",
"phones": [],
"phone": null
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Assignment timed out
When the vendor does not accept the order in time.
Example webhook payload
{
"event": "ordering::workflow::assignment_timed_out",
"data": {
"vendor_id": "82bf5583-3c63-4bed-ad00-a78048d426d6",
"order_id": "b87538ae-84fb-441e-b27c-d127f4330cfc",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2026-01-20T09:41:45.000-06:00",
"contacts": {
"borrower": {
"name": "test test",
"emails": ["kathy.fake@example.com"],
"email": "kathy.fake@example.com",
"phones": ["773-333-3333"],
"phone": "773-333-3333"
},
"vendor": {
"name": "Appraiser Example",
"email": "appraiser.fake@example.com",
"phone": "(555) 000-0004",
"license_number": "987654321"
}
}
}
}
Payout completed
When a payout to the vendor is completed
Example webhook payload
{
"event": "payouting::payout_completed",
"data": {
"payout_id": "f712ab57-fca2-4cdd-9550-57db97685a1b",
"vendor_id": "6e9aadc1-697f-42e5-b6e2-8f0ccb9103a6",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"amount": 300,
"check_number": "1242342",
"completed_at": "2026-02-12T18:00:09.000-03:00",
"transfers": [
{
"amount": 30000,
"order_id": "acfb9a80-0741-46ae-9957-212a49466125",
"status": "standing",
"error": null,
"scheduled_at": "2026-02-22T17:41:38.000-03:00",
"fulfilled_at": null,
"cancelled_at": null,
"cancel_reason": null,
"created_at": "2026-02-12T17:41:38.000-03:00",
"id": null
}
]
}
}
Terms changed
Order has changed its terms - due date and fees.
Example webhook payload
{
"event": "ordering::order_terms_changed",
"data": {
"order_id": "72636696-d58c-425b-884b-bd771f1e1d3d",
"old_data": {
"due_date": "2025-12-05T20:59:59.000-03:00",
"products": {
"41efc469-eb78-4063-b63d-dfe57ddba976": "CONV CONDO (FNMA 1073)"
},
"paying_fee": "500.0",
"product_ids": ["41efc469-eb78-4063-b63d-dfe57ddba976"],
"payouting_fee": "350.0",
"vendor_due_date": "2025-12-04T20:59:59.000-03:00"
},
"new_data": {
"due_date": "2025-12-05T20:59:59.000-03:00",
"products": {
"41efc469-eb78-4063-b63d-dfe57ddba976": "CONV CONDO (FNMA 1073)"
},
"paying_fee": "500.0",
"product_ids": ["41efc469-eb78-4063-b63d-dfe57ddba976"],
"payouting_fee": "345.0",
"vendor_due_date": "2025-12-03T20:59:59.000-03:00"
},
"skip_negotiation": true,
"comments": "Avada Kedavra",
// these two next params is deprecated and will be removed in the future
"order_fee_items": [
{
"fee": "500.0",
"product_id": "41efc469-eb78-4063-b63d-dfe57ddba976"
}
],
"vendor_fee_items": [
{
"fee": "345.0",
"product_id": "41efc469-eb78-4063-b63d-dfe57ddba976"
}
]
}
}
Quality Assurance - Revision Asked
when the staff requires adjustments to the vendor submit
Example webhook payload
{
"event": "ordering::workflow::quality_assurance_workflow::revision_asked",
"data": {
"content": "<div>test revision content</div>",
"user_id": "fccbc598-cb8d-4b76-839b-3c2a16fb40d4",
"order_id": "72636696-d58c-425b-884b-bd771f1e1d3d",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2025-11-25T12:23:26.000-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"emails": ["borrower@email.com"],
"email": "borrower@email.com",
"phones": ["555-123-1234"],
"phone": "555-123-1234"
},
"vendor": {
"name": "John Doe",
"email": "john.doe@email.com",
"phone": "(555) 123-1234",
"license_number": null
}
}
}
}
Unassigned
When the order is unassigned, meaning the old vendor is not responsible anymore
Example webhook payload
{
"event": "ordering::workflow::unassigned",
"data": {
"vendor_id": "814395f5-e672-4fd2-9ae0-a4b3cb55ddbe",
"from_integration": false,
"product_ids": ["41efc469-eb78-4063-b63d-dfe57ddba976"],
"order_id": "7088e225-6b4a-4d69-a6c3-e2416948ac5e",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"created_at": "2025-11-25T15:14:11.000-03:00",
"contacts": {
"borrower": {
"name": "John Doe",
"emails": [],
"email": null,
"phones": [],
"phone": null
}
}
}
}
Canceled
Order canceled
Example webhook payload
{
"event": "ordering::workflow::client_request_workflow::cancelled",
"data": {
"order_id": "875dd584-2485-4bff-b803-35fe4178e8a1",
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"vendor_id": "6e9aadc1-697f-42e5-b6e2-8f0ccb9103a6",
"user_id": "fccbc598-cb8d-4b76-839b-3c2a16fb40d4",
"cancel_type": "trip_fee",
"cancel_reason": "order cancelled",
"trip_fee": {
"product_id": "b17e567f-b185-4e37-8674-b0a744b4f07f",
"paying_fee": "20.0",
"payouting_fee": "10.0",
"client_confirmed": false,
"client_approver_name": ""
},
"notify_vendor": true,
"notification_type": "email",
"notify_vendor_message": "order cancelled",
"attachment": null,
"created_at": "2026-01-12T10:40:15.000-03:00",
"contacts": {
"borrower": {
"name": "test t test",
"email": null,
"emails": [],
"phone": null,
"phones": []
},
"vendor": {
"name": "Vendor Example",
"email": "mail@email.com",
"phone": "(555) 000-0002",
"license_number": "123456789"
}
}
}
}
Details changed
When order details are modified.
Example webhook payload
{
"event": "ordering::order_setup::details_changed",
"data": {
"order_id": "bd9654f5-1c1e-4cf2-8b23-fb1d6ac45476",
"company_id": "d52663d2-54f2-4fd9-b515-e830de8e3888",
"user_id": "fccbc598-cb8d-4b76-839b-3c2a16fb40d4",
"order_changes": {
"occupancy_type": [null, "primary_residence"]
},
"old_data": {
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"client_name": "ABC Bank",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_name": "ABC Bank",
"loan_type": "conventional",
"loan_number": "5436456",
"fha_case_number": null,
"transaction_type": "refinance",
"property_type": "condo",
"occupancy_type": null,
"estate_held_type": null,
"client_file_number": "",
"green_certified": false,
"inspection_scheduled_at": "2026-02-12T12:34:00.000-03:00",
"closing_date": null,
"special_instructions": "..."
},
"new_data": {
"client_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"client_name": "ABC Bank",
"lender_id": "5f188c48-0bd9-4416-9120-a907fecfd9cf",
"lender_name": "ABC Bank",
"loan_type": "conventional",
"loan_number": "5436456",
"fha_case_number": null,
"transaction_type": "refinance",
"property_type": "condo",
"occupancy_type": "primary_residence",
"estate_held_type": null,
"client_file_number": "",
"green_certified": false,
"inspection_scheduled_at": "2026-02-12T12:34:00.000-03:00",
"closing_date": null,
"special_instructions": "..."
},
"files": [],
"products": [],
"appraised_value": null,
"company_name": null,
"due_date": null
}
}