Lender Webhook Events Introduction

We offer a webhook integration to keep up to date on Reggora notifications.

Loan Webhooks

These webhooks pertain to loan files.

Loan Created Webhook

This webhook will notify your integration whenever a new loan file has been created. Example payloads are shown below.

On manual creation or 1003 upload:

{
    "event_type": "loan_created",
    "event_data": {
        "loan_id": "5d6eae5f6965580623d7d81d",
        "loan_number": "044551231231",
        "related_order": null,
        "created": "2019-09-03 18:18:06.338039"
    },
    "event_time": "2019-09-03 18:18:07.601971"
}

On CSV upload (the loans array is truncated for brevity):

{
  "event_type": "loan_created",
  "event_data": {
    "loans": [
      {
        "loan_id": "5d6eafd569655806515e567b",
        "loan_number": "2048",
        "related_order": null,
        "created": "2019-09-03 18:24:21.274578"
      },
      {
        "loan_id": "5d6eafd569655806515e5684",
        "loan_number": "2049",
        "related_order": null,
        "created": "2019-09-03 18:24:21.647568"
      }
    ]
  },
  "event_time": "2019-09-03 18:24:22.077836"
}

Loan Updated Webhook

This webhook will notify your integration whenever one of your loans are edited.

{
    "event_type": "loan_updated",
    "event_data": {
        "loan_id": "5d4c3aef33636c000f3f9a51",
        "loan_number": "sdfsdfsd",
        "related_order": null,
        "created": "2019-08-08 15:08:31.250000"
    },
    "event_time": "2019-09-04 14:51:57.925502"
}

Loan Deleted Webhook

This webhook will notify your integration whenever a loan is deleted from your lender.

{
    "event_type": "loan_deleted",
    "event_data": {
        "loan_id": "5d4c3aef33636c000f3f9a51"
    },
    "event_time": "2019-09-04 14:54:46.299226"
}

Lender Order Webhooks

These webhooks pertain to orders and the status of those orders. They are available for both vendor and integrations.

Order Created Webhook

This webhook will notify your integration whenever a new order is created.

{
    "event_type": "order_created",
    "event_data": {
        "id": "5d6ebcfb696558079322c264",
        "created": "2019-09-03 19:20:27.193000",
        "status": "Finding Appraisers"
    },
    "event_time": "2019-09-03 19:20:44.057271"
}

Order Updated Webhook

This webhook will notify your integration whenever a order is updated.

{
    "event_type": "order_updated",
    "event_data": {
        "id": "5d6ebcfb696558079322c264",
        "created": "2019-09-03 19:20:27.193000",
        "status": "Finding Appraisers",
        "cu_score": "1.2",
        "lca_score": "2.0"
    },
    "event_time": "2019-09-03 19:20:44.057271"
}

The cu_score and lca_score fields in event_data are visible only when we enable this functionality for your lender.

Order Status Webhook

This webhook will notify your integration whenever one of your orders change status.

{
    "event_type": "status_update",
    "event_data": {
        "id": "5c4f16764672bb00105ea6y9",
        "status": "Accepted",
        "created": "2019-04-11 21:00:00"
    },
    "event_time": "2019-04-11 21:00:00"
}

Order Override Waiting For Payment Webhook

This webhook will notify your integration whenever one of your orders waiting for payment has been overridden.

{
    "event_type": "order_override_waiting_for_payment",
    "event_data": {
        "id": "5c4f16764672bb00105ea6y9",
        "status": "Finding Appraisers",
        "created": "2019-04-11 21:00:00"
    },
    "event_time": "2019-04-11 21:00:00"
}

Order Approved Webhook

This webhook will notify your integration whenever a submission is approved on an order.

{
    "event_type": "order_approved",
    "event_data": {
        "id": "5d7264935d0e2d003476b15d",
        "created": "2019-09-06 13:52:19.660000",
        "status": "Submitted"
    },
    "event_time": "2019-09-06 15:07:19.445753"
}

Order Placed on Hold Webhook

This webhook will notify your integration whenever an order has been placed on hold.

{
    "event_type": "order_placed_on_hold",
    "event_data": {
        "id": "5d2f6991d648010006819caf",
        "status": "Order Placed On Hold",
        "created": "2018-08-23 17:28:04.723000",
        "message": "Example Reason"
    },
    "event_time": "2019-03-17 12:00:00"
}

Order Taken Off Hold Webhook

This webhook will notify your integration whenever an order has been removed from a held state.

{
    "event_type": "order_removed_on_hold",
    "event_data": {
        "id": "5d2f6991d648010006819caf",
        "status": "Order Removed From Hold",
        "created": "2018-08-23 17:28:04.723000"
    },
    "event_time": "2019-03-17 12:00:00"
}

Order Note Created Webhook

This webhook will notify your integration whenever an order has a note added to it.

{
    "event_type": "order_note_created",
    "event_data": {
        "id": "5d7274b95d0e2d0062aa2994",
        "created": "2019-09-06 15:01:13.617000",
        "status": "Finding Appraisers",
        "note": "Test Note"
    },
    "event_time": "2019-09-06 15:46:00.271062"
}

Order Note Updated Webhook

This webhook will notify your integration whenever a note has been updated.

{
    "event_type": "order_note_updated",
    "event_data": {
        "id": "5d7274b95d0e2d0062aa2994",
        "created": "2019-09-06 15:01:13.617000",
        "status": "Finding Appraisers",
        "note": "Testing"
    },
    "event_time": "2019-09-06 15:47:19.320824"
}

Order Note Deleted Webhook

This webhook will notify your integration whenever a note has been deleted.

{
    "event_type": "order_note_deleted",
    "event_data": {
        "id": "5d7274b95d0e2d0062aa2994",
        "created": "2019-09-06 15:01:13.617000",
        "status": "Finding Appraisers",
        "note_id": "8837b86b-c87f-4521-a78c-f5c8d5151383"
    },
    "event_time": "2019-09-06 15:50:22.125242"
}

Order Reassigned Webhook

This webhook will notify your integration whenever an order has been reassigned to a new appraiser.

{
    "event_type": "order_reassigned",
    "event_data": {
        "id": "5d2f6991d648010006819caf",
        "status": "Order Reassigned",
        "created": "2018-08-23 17:28:04.723000"
    },
    "event_time": "2019-03-17 12:00:00"
}

Order Cancelled Webhook

This webhook will notify your integration whenever an order has been cancelled.

{
    "event_type": "order_cancelled",
    "event_data": {
        "id": "5d2f6991d648010006819caf",
        "status": "Order Canceled",
        "created": "2018-08-23 17:28:04.723000"
    },
    "event_time": "2019-03-17 12:00:00"
}

Lender Attention Required

This webhook will notify your integration whenever lender attention is required.

The event data is an object with the attributes below.

Event data attributes

Attribute	Description
id	Order unique identifier.
status	The current status of the order.
created	Datetime string representation of when the order was created.
lender_attention_required_reason	An explanation of why attention is needed on a specific order.

{
  "event_type": "lender_attention_required",
  "event_data": {
    "id": "5d2f6991d648010006819caf",
    "status": "Accepted",
    "created": "2021-01-19 20:37:36.812000",
    "lender_attention_required_reason": "CONSUMER_DELIVERY_FAILED"
  },
  "event_time": "2021-01-19 20:50:39.336352"
}

Revision Created Webhook

This webhook will notify your integration that a revision has been created by a lender on an order.

{
    "event_type": "revision_created",
    "event_data": {
        "order_id": "8f76c5c7c84d6c2daad9dd24",
        "revision_id": "02875ec5-89f0-4818-99b2-c751995203ee",
        "resolved": null,
        "created": "2019-09-03 17:57:53.277345",
        "text": "Testing",
        "title": "Test",
        "type": "revision",
        "attached_documents": {}
    },
    "event_time": "2019-09-03 17:57:55.809861"
}

Revision Updated Webhook

This webhook will notify your integration that a revision has been updated on an order.

{
    "event_type": "revision_updated",
    "event_data": {
        "order_id": "8f76c5c7c84d6c2daad9dd24",
        "revision_id": "8f76c5c7baa36c2daad9dd24",
        "resolved": null,
        "created": "2019-09-03 17:57:53.277345",
        "text": "Testing",
        "title": "Test"
    },
    "event_time": "2019-03-17 12:00:00"
}

Revision Resolved Webhook

This webhook will notify your integration that a revision has been resolved on an order.

{
    "event_type": "revision_resolved",
    "event_data": {
        "order_id": "8f76c5c7c84d6c2daad9dd24",
        "revision_id": "c38582ae-4123-4908-90d0-6c13e579e7e5",
        "resolved": "2019-09-05 14:21:02.112000",
        "created": "2019-09-05 14:21:02.112000",
        "text": "",
        "title": "Test"
    },
    "event_time": "2019-09-05 15:00:58.658403"
}

Revision Unresolved Webhook

This webhook will notify your integration that a revision has been unresolved on an order.

{
    "event_type": "revision_unresolved",
    "event_data": {
        "order_id": "8f76c5c7c84d6c2daad9dd24",
        "revision_id": "c38582ae-4123-4908-90d0-6c13e579e7e5",
        "resolved": null,
        "created": "2019-09-05 14:21:02.112000",
        "text": "",
        "title": "Test"
    },
    "event_time": "2019-09-05 15:00:58.658403"
}

Order Report Received

This webhook will notify your integration when a new submission has been received on an order.

{
    "event_type": "order_report_received",
    "event_data": {
        "id": "5d2f6991d648010006819caf",
        "submission_version": "1",
        "created": "2018-08-23 17:28:04.723000",
        "cu_score": "1.2",
        "lca_score": "2.0"
    },
    "event_time": "2018-08-24 19:23:04.723000"
}

The cu_score and lca_score fields in event_data are visible only when we enable this functionality for your lender.

Order Ready for Review

This webhook will notify your integration when an order’s review is ready.

{
    "event_type": "order_ready_for_review",
    "event_data": {
        "id": "622b787b1179578f61e46071",
        "created": "2022-03-11 16:27:39.159000",
        "status": "Under Review"
    },
    "event_time": "2022-03-11 16:27:39.159000"
}

Order Report Sent

This webhook will notify your integration that an order’s report has been sent to one of the consumers on the order.

{
    "event_type": "order_report_sent",
    "event_data": {
        "order_id": "5d2f6991d648010006819caf",
        "status": "Report Sent",
        "created": "2018-08-23 17:28:04.723000",
        "consumer_id_list": [
            "72ddc515-76c3-4537-8911-ac0c9f5b800e"
        ],
        "submission_version": 1
    }
}

Order Report Downloaded

This webhook will notify your integration that an order’s report has been downloaded by one of the consumers on the order.

{
    "event_type": "order_report_downloaded",
    "event_data": {
        "order_id": "5d2f6991d648010006819caf",
        "status": "Submitted",
        "consumer_email": "consumer@reggora.com",
        "created": "2018-08-23 17:28:04.723000",
        "submission_version": 1,
        "consumer_id": "72ddc515-76c3-4537-8911-ac0c9f5b800e"
    }
}

This webhook will notify your integration that an order’s consumer has denied electronic consent to download the report.

{
    "event_type": "order_electronic_consent_denied",
    "event_data": {
        "order_id": "5d2f6991d648010006819caf",
        "status": "Submitted",
        "consumer_email": "consumer@reggora.com",
        "created": "2018-08-23 17:28:04.723000",
        "submission_version": 1,
        "consumer_id": "72ddc515-76c3-4537-8911-ac0c9f5b800e"
    }
}

Order Submission Matched Exclusionary List

This webhook will notify your integration that a submission on an order was completed by an appraiser in your exclusionary list.

{
    "event_type": "order_submission_matched_exclusionary_list",
    "event_data": {
        "order_id": "5d2f6991d648010006819caf",
        "status": "Submitted",
        "created": "2018-08-23 17:28:04.723000"
    }
}

Order Submitted To UCDP

This webhook will notify your integration that a submission has been uploaded to UCDP.

{
    "event_type": "order_submitted_to_ucdp",
    "event_data": {
        "loan_id": "5d726daf5d0e2d003476b1fc",
        "loan_number": "9060039",
        "related_order": "5d72b2502bfcb20313ceacb3",
        "created": "2019-09-06 14:31:10.879000"
    },
    "event_time": "2019-09-06 19:27:17.555055"
}

Order Submitted To EAD

This webhook will notify your integration that a submission has been uploaded to EAD.

{
    "event_type": "order_submitted_to_ead",
    "event_data": {
        "loan_id": "5d726daf5d0e2d003476b1fc",
        "loan_number": "9060039",
        "related_order": "5d72b2502bfcb20313ceacb3",
        "created": "2019-09-06 14:31:10.879000"
    },
    "event_time": "2019-09-06 19:27:17.555055"
}

SSR Document Ready

This webhook will notify your integration when UCDP/EAD submission results are ready. SSR document URLs are presigned links valid for 24 hours.

Event data attributes

Attribute	Description
lender_id	Lender unique identifier.
loan_id	Loan file unique identifier. (Note: appears as `load_id` in some integration paths — a pre-existing field name that will be corrected in a future change.)
order_id	Order unique identifier.
submission_version	Integer version of the submission whose SSR documents are being announced. Matches the `version` field returned by `GET /api_v2/integrations/order-submissions/<order_id>`. Value is `null` if the version could not be determined.
fannie_ssr	Presigned S3 URL for the Fannie Mae SSR PDF. Present only when returned by UCDP.
freddie_ssr	Presigned S3 URL for the Freddie Mac SSR PDF. Present only when returned by UCDP.
fha_ssr	Presigned S3 URL for the FHA SSR PDF. Present only when returned by EAD.

UCDP example

{
    "event_type": "ssr_document_ready",
    "event_data": {
        "lender_id": "5d726daf5d0e2d003476b1fc",
        "loan_id": "5d726daf5d0e2d003476b1fc",
        "order_id": "5d72b2502bfcb20313ceacb3",
        "submission_version": 1,
        "fannie_ssr": "https://s3.amazonaws.com/reggora-docs/path/to/fannie_ssr.pdf?AWSAccessKeyId=...&Signature=...&Expires=...",
        "freddie_ssr": "https://s3.amazonaws.com/reggora-docs/path/to/freddie_ssr.pdf?AWSAccessKeyId=...&Signature=...&Expires=..."
    },
    "event_time": "2025-09-06 19:27:17.555055"
}

EAD example

{
    "event_type": "ssr_document_ready",
    "event_data": {
        "lender_id": "5d726daf5d0e2d003476b1fc",
        "loan_id": "5d726daf5d0e2d003476b1fc",
        "order_id": "5d72b2502bfcb20313ceacb3",
        "submission_version": 1,
        "fha_ssr": "https://s3.amazonaws.com/reggora-docs/path/to/fha_ssr.pdf?AWSAccessKeyId=...&Signature=...&Expires=..."
    },
    "event_time": "2025-09-06 19:32:45.123456"
}

Order Warranty Status Updated

This webhook will notify your integration whenever an order’s warranty status has been updated.

{
    "event_type": "order_warranty_status_updated",
    "event_data": {
        "loan_id": "5d726daf5d0e2d003476b1fc",
        "loan_number": "9060039",
        "order_id": "5d72b2502bfcb20313ceacb3",
        "submission_version": 1
    },
    "event_time": "2025-09-06 19:27:17.555055"
}

Fee Escalation Created

This webhook will notify your integration that a fee escalation has been created.

{
  "event_type": "fee_escalation_created",
  "event_data": {
    "fee_escalation_id": "c3adad5f-1d59-49bf-865f-ea16562d9fd7",
    "order_id": "5d72b2502bfcb20313ceacb3",
    "requested_fee": 650.00,
    "requested_due_date": "2020-05-28 15:17:20.338952",
    "reason": "This is a comment"
  },
  "event_time": "2020-05-28 15:17:20.338952"
}

Fee Escalation Request Accepted

This webhook will notify your integration that a fee escalation request has been accepted.

{
  "event_type": "fee_escalation_request_accepted",
  "event_data": {
    "initial_fee": 925,
    "current_fee": 950,
    "fee_escalation_id": "c3adad5f-1d59-49bf-865f-ea16562d9fd7",
    "order_id": "5eced312f6d97d01efc93d88"
  },
  "event_time": "2020-05-28 15:17:20.338952"
}

Fee Escalation Request Denied

This webhook will notify your integration that a fee escalation request has been denied.

{
  "event_type": "fee_escalation_request_denied",
  "event_data": {
    "fee_escalation_id": "eae69691-9df7-4a77-8d73-f8eabb1ffd56",
    "order_id": "5eced312f6d97d01efc93d88"
  },
  "event_time": "2020-05-28 15:16:00.498833"
}

Lender Payment Webhooks

These webhooks are triggered when the lender interacts with the vendor payments. They are available for both vendors and lenders.

Vendor Payment Created Webhook

This webhook will notify your integration whenever a vendor payment has been created.

{
    "event_type": "vendor_payment_created",
    "event_data": {
        "order_id": "5c4f16764672bb00105ea6y9",
        "payment_id": "5d7280eb2bfcb2025bf267fb",
        "amount": "10.00",
        "description": "USNS Chang, Lake Christianshire, VIRGINIA"
    },
    "event_time": "2019-09-06 15:53:20.000306"
}

Vendor Payment Updated Webhook

This webhook will notify your integration whenever a vendor payment is edited.

{
    "event_type": "vendor_payment_updated",
    "event_data": {
        "order_id": "5c4f16764672bb00105ea6y9",
        "payment_id": "bad69636-346a-490c-ad10-15bb76fea67e",
        "amount": "34.86",
        "description": "USNS Chang, Lake Christianshire, VIRGINIA"
    },
    "event_time": "2019-09-04 18:16:07.357064"
}

Vendor Payment Deleted Webhook

This webhook will notify your integration whenever a vendor payment is deleted.

{
    "event_type": "vendor_payment_deleted",
    "event_data": {
        "order_id": "5c4f16764672bb00105ea6y9",
        "payment_id": "3ac2780e-ee93-4bec-b171-504881c616b3",
        "amount": "34.86",
        "description": "USNS Chang, Lake Christianshire, VIRGINIA"
    },
    "event_time": "2019-09-04 18:20:28.317856"
}

Vendor Payment Delivered Webhook

This webhook will notify your integration whenever a vendor payment has been delivered to the appraiser.

{
    "event_type": "vendor_payment_delivered",
    "event_data": {
        "order_id": "5c4f16764672bb00105ea6y9",
        "payment_id": "5d7280eb2bfcb2025bf267fb",
        "amount": "10.00",
        "description": "USNS Chang, Lake Christianshire, VIRGINIA"
    },
    "event_time": "2019-09-06 15:53:20.000306"
}

Lender eVault Webhooks

These webhooks pertain to the eVault and our file storage system. They are available for both vendors and lenders.

eVault Webhook

This webhook will notify your integration whenever a document has been uploaded by a vendor to one of your orders.

{
    "event_type": "evault_uploaded",
    "event_data": {
        "order_id": "5c4f16764672bb00105ea6y9",
        "evault_id": "5c4f16764672bb00105ea6y2",
        "document_id": "5c4f16764672bb00105ea2c4",
        "created": "2019-03-17 12:00:00"
    },
    "event_time": "2019-03-17 12:00:00"
}

Lender Conversation Webhooks

These webhooks pertain to conversations and the messages that belong to them. They are available for vendors and lenders.

Message Received Webhook

This webhook will notify your integration whenever a message has been received from a client on one of your orders.

{
    "event_type": "new_message",
    "event_data": {
        "order_id": "5c4f16764672bb00105ea6y9",
        "conversation_id": "5d6e89e01fe14c000b32e868",
        "message": "Reggora Rocks!",
        "time_stamp": "2019-04-11 15:00:00"
    },
    "event_time": "2019-04-11 15:00:00"
}

Message Sent Webhook

This webhook will notify your integration whenever a message has been sent to a client on one of your orders.

{
    "event_type": "message_sent",
    "event_data": {
        "order_id": "5c4f16764672bb00105ea6y9",
        "conversation_id": "5d6e89e01fe14c000b32e868",
        "message_id": "448556a8-2e76-4030-9358-e7a099d8963e",
        "message": "Reggora Rocks!",
        "time_stamp": "2019-04-11 15:00:00"
    },
    "event_time": "2019-04-11 15:00:00"
}

User Webhooks

These webhooks pertain to the users added, edited, and removed from your integration accounts. They are available for vendors and lenders.

User Created Webhook

This webhook will notify your integration whenever a new user has been created.

{
    "event_type": "user_created",
    "event_data": {
        "id": "5232e23efqd12eg53232",
        "email": "newuser@example.com",
        "firstname": "Jerry",
        "lastname": "Seinfeld",
        "role": "admin",
        "created": "2019-03-17 12:00:00"
    },
    "event_time": "2019-03-17 12:00:00"
}

User Updated Webhook

This webhook will notify your integration whenever a user has been updated.

{
    "event_type": "user_updated",
    "event_data": "5232e23efqd12eg53232",
    "event_time": "2019-03-17 12:00:00"
}

User Deleted Webhook

This webhook will notify your integration whenever a user has been deleted.

{
    "event_type": "user_deleted",
    "event_data": "5d0bb0423afee00034be22dc",
    "event_time": "2019-09-03 19:59:40.903714"
}

User Invited Webhook

This webhook will notify your integration whenever a user has been invited.

{
    "event_type": "user_invited",
    "event_data": {
        "id": "5d6ec84d696558081d447e29",
        "email": "fake@reggora.com",
        "firstname": "Fake",
        "lastname": "User",
        "role": "Admin",
        "created": "2019-03-17 12:00:00"
    },
    "event_time": "2019-09-03 20:08:46.421038"
}

Lender Vendor Webhooks

These webhooks pertain to your integrations interaction and activity with vendors. They are available for integrations.

Vendor Created Webhook

This webhook will notify your integration whenever a vendor has been created.

{
    "event_type": "vendor_invited",
    "event_data": "5d7012929e5e66006244d947",
    "event_time": "2019-09-04 19:37:55.044381"
}

Vendor CSV Uploaded Webhook

This webhook will notify your integration whenever vendors are invited from a csv upload.

{
    "event_type": "vendor_csv_uploaded",
    "event_data": [
        "5d72782b5d0e2d00be590a08",
        "5d72782c5d0e2d00be590a0c"
    ],
    "event_time": "2019-09-06 15:15:57.332117"
}

Vendor Updated Webhook

This webhook will notify your integration whenever a vendor has been updated.

{
    "event_type": "vendor_updated",
    "event_data": "5c7024c1f72d830020288ad7",
    "event_time": "2019-09-04 15:13:57.010377"
}

Vendor Deleted Webhook

This webhook will notify your integration whenever a vendor has been removed from your panel.

{
    "event_type": "vendor_deleted",
    "event_data": "5c7024c1f72d830020288ad7",
    "event_time": "2019-09-04 15:13:57.010377"
}

Exclusionary List Added Webhook

This webhook will notify your integration whenever an appraiser has been added to an exclusionary list.

{
    "event_type": "exclusionary_list_added",
    "event_data": {
        "excluded": [
            {
                "id": "100*MA",
                "name": ["Test User"],
                "license_number": "100",
                "license_state": "MA"
            }
        ]
    },
    "event_time": "2019-09-04 15:26:10.813081"
}

Exclusionary List Uploaded Webhook

This webhook will notify your integration whenever an exclusionary list has been uploaded and added to your list.

{
    "event_type": "exclusionary_list_uploaded",
    "event_data": {
        "excluded": [
            {
                "id": "RD45555*FL",
                "name": [
                    "Appraisal Central"
                ],
                "license_number": "RD45555",
                "license_state": "FL"
            },
            {
                "id": "3000MHB*MD",
                "name": [
                    "David Beckham"
                ],
                "license_number": "3000MHB",
                "license_state": "MD"
            }
        ]
    },
    "event_time": "2019-09-04 17:09:25.044266"
}

Exclusionary List Removed Webhook

This webhook will notify your integration whenever a member has been removed from your exclusionary list. It will display the remaining exclusions.

{
    "event_type": "exclusionary_list_removed",
    "event_data": {
        "excluded": []
    },
    "event_time": "2019-09-04 15:28:12.324693"
}

Lender Branch Webhooks

These webhooks pertain to branches on your lender’s integration account. They are available for lenders only.

Branch Created Webhook

This webhook will notify your integration whenever a branch has been created on your lender.

{
    "event_type": "branch_created",
    "event_data": {
        "branch_id": "5d6ecfdb69655808d5b3d012",
        "branch_identifier": "test_branch_1",
        "name": "test branch",
        "address": "123 Main St",
        "city": "Boston",
        "state": "MA",
        "ZIP": "90210",
        "branch_classification": "retail",
        "is_joint_venture": false,
        "contact_phone_number": "555-555-5555",
        "contact_email": "email@testreggora.com",
        "loan_officers": [
            {
                "id": "6373c8fcd74957d911629dcf",
                "email": "email@testreggora.com",
                "firstname": "Homer",
                "lastname": "Simpson",
                "phone_number": "1234567890",
                "created": "2022-11-15 17:15:50.307000"
            }
        ],
        "parent_branch_identifier": "test_branch_2",
        "exists_in_hierarchy": true
    },
    "event_time": "2022-11-15 17:15:50.307000"
}

Branch Updated Webhook

This webhook will notify your integration whenever a branch has been updated on your lender, including soft deletes. If we are deleting a branch, then we only send the branch_id, branch_identifier, and branch_name in the event data. Otherwise, the branch data in its entirety will be sent.

Soft-delete payload:

{
    "event_type": "branch_updated",
    "event_data": {
        "branch_id": "5d6ecfdb69655808d5b3d012",
        "branch_identifier": "TBNT",
        "branch_name": "Test Branch New Test"
    },
    "event_time": "2019-09-03 20:41:12.525847"
}

Full update payload:

{
    "event_type": "branch_updated",
    "event_data": {
        "branch_id": "5d6ecfdb69655808d5b3d012",
        "branch_identifier": "test_branch_1",
        "name": "test branch",
        "address": "123 Main St",
        "city": "Boston",
        "state": "MA",
        "ZIP": "90210",
        "branch_classification": "retail",
        "is_joint_venture": false,
        "contact_phone_number": "555-555-5555",
        "contact_email": "email@testreggora.com",
        "loan_officers": [
            {
                "id": "6373c8fcd74957d911629dcf",
                "email": "email@testreggora.com",
                "firstname": "Homer",
                "lastname": "Simpson",
                "phone_number": "1234567890",
                "created": "2022-11-15 17:15:50.307000"
            }
        ],
        "parent_branch_identifier": "test_branch_2",
        "exists_in_hierarchy": true
    },
    "event_time": "2022-11-15 17:15:50.307000"
}

Branch Zone Updated Webhook

This webhook will notify your integration whenever a branch’s zone allocation methods have been updated on the lender side.

{
    "event_type": "branch_zones_updated",
    "event_data": {
        "branch_id": "5d6ecfdb69655808d5b3d012",
        "branch_identifier": "test_branch_1",
        "name": "test branch",
        "address": "123 Main St",
        "city": "Boston",
        "state": "MA",
        "ZIP": "90210",
        "branch_classification": "retail",
        "is_joint_venture": false,
        "contact_phone_number": "555-555-5555",
        "contact_email": "email@testreggora.com",
        "loan_officers": [
            {
                "id": "6373c8fcd74957d911629dcf",
                "email": "email@testreggora.com",
                "firstname": "Homer",
                "lastname": "Simpson",
                "phone_number": "1234567890",
                "created": "2022-11-15 17:15:50.307000"
            }
        ],
        "parent_branch_identifier": "test_branch_2",
        "exists_in_hierarchy": true
    },
    "event_time": "2019-09-06 15:33:02.383468"
}

Branch Vendor Added Webhook

This webhook will notify your integration whenever a branch has had a vendor added to it on your lender.

{
    "event_type": "branch_vendor_added",
    "event_data": {
        "branch_id": "5d6ecfdb69655808d5b3d012",
        "branch_identifier": "test_branch_1",
        "name": "test branch",
        "address": "123 Main St",
        "city": "Boston",
        "state": "MA",
        "ZIP": "90210",
        "branch_classification": "retail",
        "is_joint_venture": false,
        "contact_phone_number": "555-555-5555",
        "contact_email": "email@testreggora.com",
        "loan_officers": [
            {
                "id": "6373c8fcd74957d911629dcf",
                "email": "email@testreggora.com",
                "firstname": "Homer",
                "lastname": "Simpson",
                "phone_number": "1234567890",
                "created": "2022-11-15 17:15:50.307000"
            }
        ],
        "parent_branch_identifier": "test_branch_2",
        "exists_in_hierarchy": true,
        "vendor_ids":["5c7024c1f72d830020288ad7", "5c7024e6f72d830020288adb"]
    },
    "event_time": "2019-09-04 14:58:32.994752"
}

Branch Vendor Removed Webhook

This webhook will notify your integration whenever a branch has had a vendor removed from it on your lender.

{
    "event_type": "branch_vendor_removed",
    "event_data": {
        "branch_id": "5d6ecfdb69655808d5b3d012",
        "branch_identifier": "test_branch_1",
        "name": "test branch",
        "address": "123 Main St",
        "city": "Boston",
        "state": "MA",
        "ZIP": "90210",
        "branch_classification": "retail",
        "is_joint_venture": false,
        "contact_phone_number": "555-555-5555",
        "contact_email": "email@testreggora.com",
        "loan_officers": [
            {
                "id": "6373c8fcd74957d911629dcf",
                "email": "email@testreggora.com",
                "firstname": "Homer",
                "lastname": "Simpson",
                "phone_number": "1234567890",
                "created": "2022-11-15 17:15:50.307000"
            }
        ],
        "parent_branch_identifier": "test_branch_2",
        "exists_in_hierarchy": true,
        "vendor_id": "5c701a2ff72d830020288ab0"
    },
    "event_time": "2019-09-04 15:10:00.826984"
}

Lender Product Webhooks

These webhooks pertain to lender products. They are available for lenders only.

Product Created Webhook

This webhook will notify your integration whenever a product is created.

{
    "event_type": "product_created",
    "event_data": "5d6ff0a271cb1f00bfda19b6",
    "event_time": "2019-09-04 17:13:07.176457"
}

Product Updated Webhook

This webhook will notify your integration whenever a product is updated.

{
    "event_type": "product_updated",
    "event_data": {
        "product_id": "5c704514f72d830020288b3a",
        "product_name": "Test Product",
        "amount": "1002.00"
    },
    "event_time": "2019-09-04 17:14:01.433414"
}

Product Deleted Webhook

This webhook will notify your integration whenever a product is deleted.

{
    "event_type": "product_deleted",
    "event_data": "5d518394425e420061bd135b",
    "event_time": "2019-09-04 17:15:39.645117"
}

Product Note Created Webhook

This webhook will notify your integration whenever a product note is created.

{
    "event_type": "product_note_created",
    "event_data": {
        "product_id": "5c704514f72d830020288b3a",
        "product_name": "Test Product",
        "note_id": "ad21375a-0146-4fdd-a89b-d4d550e903df"
    },
    "event_time": "2019-09-04 17:19:05.191973"
}

Product Note Updated Webhook

This webhook will notify your integration whenever a product note is edited.

{
    "event_type": "product_note_updated",
    "event_data": {
        "product_id": "5c704514f72d830020288b3a",
        "product_name": "Test Product",
        "note_id": "ad21375a-0146-4fdd-a89b-d4d550e903df"
    },
    "event_time": "2019-09-04 17:20:59.379658"
}

Product Note Deleted Webhook

This webhook will notify your integration whenever a product note is deleted.

{
    "event_type": "product_note_deleted",
    "event_data": "ad21375a-0146-4fdd-a89b-d4d550e903df",
    "event_time": "2019-09-04 17:22:41.757001"
}

Product Document Uploaded

This webhook will notify your integration whenever an included form has been added to a product.

{
    "event_type": "product_document_uploaded",
    "event_data": {
        "product_id": "5c704514f72d830020288b3a",
        "product_name": "Test Product",
        "document_id": "2d3c4f5c-cf3a-11e9-840a-0242a4120002",
        "document_name": "test_upload.pdf"
    },
    "event_time": "2019-09-04 17:33:58.806943"
}

Product Document Deleted

This webhook will notify your integration whenever an included form has been removed from a product. This will return the document id.

{
    "event_type": "product_document_deleted",
    "event_data": "bb72c7fe-5ad9-11e9-a403-0242ac120002",
    "event_time": "2019-09-04 17:31:52.112822"
}

Company Order Webhooks

These webhooks pertain to orders and the status of those orders for an appriasal companies.

Fee escalation accept

This webhook will notify your integration whenever a fee escalation has been accepted for an appraisal company.

{
  "event_type": "fee_escalation_request_accepted",
  "event_data": {
    "initial_fee": 3100,
    "current_fee": 6100,
    "fee_escalation_id": "abc84b8a-3c78-4eaf-94da-5777852f7183",
    "order_id": "5fad820998f433014ef2abf6"
  },
  "event_time": "2020-11-12 20:50:30.937437"
}

Fee escalation deny

This webhook will notify your integration whenever a fee escalation has been deny for an appraisal company.

{
  "event_type": "fee_escalation_request_denied",
  "event_data": {
    "fee_escalation_id": "51c88a4b-26f3-4cc4-bc7f-f0922aebb8e9",
    "order_id": "5fa443bcf7e5530c945d951a"
  },
  "event_time": "2020-11-12 16:30:39.222568"
}

Counter offer accept

This webhook will notify your integration whenever a Counter offer has been accepted for an appraisal company.

{
  "event_type": "counter_offer_accepted",
  "event_data": {
    "due_date": "2020-11-17 12:00:00",
    "current_fee": "4000.0",
    "order_id": "5fad820998f433014ef2abf6"
  },
  "event_time": "2020-11-12 20:48:11.338204"
}

Counter offer deny

This webhook will notify your integration whenever a Counter offer has been denied for an appraisal company.

{
  "event_type": "counter_offer_denied",
  "event_data": {
    "order_id": "5fad820998f433014ef2abf6"
  },
  "event_time": "2020-11-12 20:48:11.338204"
}

Consumer Webhooks

These webhooks pertain to consumers and consumer payments. They are available for lenders only.

Consumer Payment Created Webhook

This webhook will notify your integration whenever a consumer payment is generated.

{
    "event_type": "consumer_payment_created",
    "event_data": {
        "order_id": "5c704514f72d830020288b3a",
        "payment_id": "bad69636-346a-490c-ad10-15bb76fea67e",
        "amount": "34.86",
        "description": "USNS Chang, Lake Christianshire, VIRGINIA"
    },
    "event_time": "2019-09-04 17:57:16.903718"
}

Consumer Payment Updated Webhook

This webhook will notify your integration whenever a consumer payment is edited.

{
    "event_type": "consumer_payment_updated",
    "event_data": {
        "order_id": "5c704514f72d830020288b3a",
        "payment_id": "bad69636-346a-490c-ad10-15bb76fea67e",
        "amount": "34.86",
        "description": "USNS Chang, Lake Christianshire, VIRGINIA"
    },
    "event_time": "2019-09-04 18:16:07.357064"
}

Consumer Payment Deleted Webhook

This webhook will notify your integration whenever a consumer payment is deleted.

{
    "event_type": "consumer_payment_deleted",
    "event_data": {
        "order_id": "5c704514f72d830020288b3a",
        "payment_id": "bad69636-346a-490c-ad10-15bb76fea67e",
        "amount": "34.86",
        "description": "USNS Chang, Lake Christianshire, VIRGINIA"
    },
    "event_time": "2019-09-04 18:17:00.464056"
}

Consumer Payment Completed Webhook

This webhook will notify your integration whenever a consumer payment is completed (by either borrower or lender).

{
    "event_type": "consumer_payment_completed",
    "event_data": {
        "order_id": "5c704514f72d830020288b3a",
        "payment_id": "bad69636-346a-490c-ad10-15bb76fea67e",
        "amount": "34.86",
        "description": "USNS Chang, Lake Christianshire, VIRGINIA"
    },
    "event_time": "2019-09-04 18:17:00.464056"
}

Consumer Created Webhook

This webhook will notify your integration whenever a consumer has been added to a loan file.

{
    "event_type": "consumer_created",
    "event_data": {
        "id": "366b4814-c75f-4437-b035-900dcabfd866",
        "full_name": "Fake Borrower",
        "email": "fake@reggora.com",
        "role": "borrower"
    },
    "event_time": "2019-09-04 14:23:52.681213"
}

Consumer Updated Webhook

This webhook will notify your integration whenever a consumer has been edited.

{
    "event_type": "consumer_updated",
    "event_data": {
        "id": "aa678c59-c18e-4493-a9fd-ebac14df713b"
    },
    "event_time": "2019-09-05 14:18:30.511737"
}

Lender Webhook Events Introduction

Loan Webhooks

Loan Created Webhook

Loan Updated Webhook

Loan Deleted Webhook

Lender Order Webhooks

Order Created Webhook

Order Updated Webhook

Order Status Webhook

Order Override Waiting For Payment Webhook

Order Approved Webhook

Order Placed on Hold Webhook

Order Taken Off Hold Webhook

Order Note Created Webhook

Order Note Updated Webhook

Order Note Deleted Webhook

Order Reassigned Webhook

Order Cancelled Webhook

Lender Attention Required

Event data attributes

Revision Created Webhook

Revision Updated Webhook

Revision Resolved Webhook

Revision Unresolved Webhook

Order Report Received

Order Ready for Review

Order Report Sent

Order Report Downloaded

Order Electronic Consent Denied

Order Submission Matched Exclusionary List

Order Submitted To UCDP

Order Submitted To EAD

SSR Document Ready

Event data attributes

Order Warranty Status Updated

Fee Escalation Created

Fee Escalation Request Accepted

Fee Escalation Request Denied

Lender Payment Webhooks

Vendor Payment Created Webhook

Vendor Payment Updated Webhook

Vendor Payment Deleted Webhook

Vendor Payment Delivered Webhook

Lender eVault Webhooks

eVault Webhook

Lender Conversation Webhooks

Message Received Webhook

Message Sent Webhook

User Webhooks

User Created Webhook

User Updated Webhook

User Deleted Webhook

User Invited Webhook

Lender Vendor Webhooks

Vendor Created Webhook

Vendor CSV Uploaded Webhook

Vendor Updated Webhook

Vendor Deleted Webhook

Exclusionary List Added Webhook

Exclusionary List Uploaded Webhook

Exclusionary List Removed Webhook

Lender Branch Webhooks

Branch Created Webhook

Branch Updated Webhook

Branch Zone Updated Webhook

Branch Vendor Added Webhook

Branch Vendor Removed Webhook

Lender Product Webhooks

Product Created Webhook

Product Updated Webhook

Product Deleted Webhook

Product Note Created Webhook

Product Note Updated Webhook

Product Note Deleted Webhook

Product Document Uploaded

Product Document Deleted

Company Order Webhooks

Fee escalation accept

Fee escalation deny

Counter offer accept