Vendor Webhook Introduction

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

Vendor Order Webhooks

These webhooks have to do with orders and the status of those orders.

Order Received Webhook

This webhook will notify your integration whenever a new order is created and sent to your appraiser.

{
    "event_type": "new_order",
    "event_data": {
        "id": "5d7274b95d0e2d0062aa2994",
        "created": "2019-09-06 15:01:13.617000",
        "status": "Finding Appraisers"
    },
    "event_time": "2019-09-06 15:01:24.511932"
}

Order Updated Webhook

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

{
    "event_type": "order_updated",
    "event_data": {
        "id": "5d6ebcfb696558079322c264",
        "created": "2019-09-03 19:20:27.193000",
        "status": "Inspection Scheduled"
    },
    "event_time": "2019-09-03 19:20:44.057271"
}

Order Placed on Hold Webhook

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

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.
message	An explanation of why the order has been put on hold.

Two events are emitted — one capturing the order’s prior status and one reflecting the new Hold status:

{
    "event_type": "order_placed_on_hold",
    "event_data": {
        "id": "5e9eee68561ed9000b6cc53e",
        "created": "2020-04-21 13:00:24.439000",
        "status": "Inspection Scheduled",
        "message": "Missing required documents"
    },
    "event_time": "2020-04-22 13:29:08.912629"
}

{
    "event_type": "order_placed_on_hold",
    "event_data": {
        "id": "5e9eee68561ed9000b6cc53e",
        "created": "2020-04-21 13:00:24.439000",
        "status": "Hold",
        "message": "Missing required documents"
    },
    "event_time": "2020-04-22 13:29:11.912629"
}

Order Taken Off Hold Webhook

This webhook will notify your integration whenever an order has been removed from a held state. Two events are emitted — one reflecting the resumed status and one capturing the Unhold transition:

{
    "event_type": "order_removed_on_hold",
    "event_data": {
        "id": "5e9eee68561ed9000b6cc53e",
        "created": "2020-04-21 13:00:24.439000",
        "status": "Inspection Scheduled"
    },
    "event_time": "2020-04-22 13:34:35.505958"
}

{
    "event_type": "order_removed_on_hold",
    "event_data": {
        "id": "5e9eee68561ed9000b6cc53e",
        "created": "2020-04-21 13:00:24.439000",
        "status": "Unhold"
    },
    "event_time": "2020-04-22 13:34:36.634373"
}

Order Cancelled Webhook

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

{
    "event_type": "order_cancelled",
    "event_data": {
        "id": "5e8381615f4aac000b077101",
        "created": "2020-03-31 17:44:01.700000",
        "status": "Cancelled"
    },
    "event_time": "2020-04-22 16:36:44.133376"
}

Revision Requested Webhook

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

{
    "event_type": "revision_created",
    "event_data": {
        "revision_id": "ee2d0b60-35d6-4467-811d-27364dffcf01",
        "created": "2020-04-28 16:41:05.667017",
        "resolved": null,
        "text": "api",
        "title": "API Test",
        "order_id": "5e6ff89e8284e20008276a06"
    },
    "event_time": "2020-04-28 16:41:06.506132"
}

Reconsideration of Value Created Webhook

This webhook will notify your integration whenever a reconsideration of value has been requested on an order.

{
    "event_type": "reconsideration_of_value_created",
    "event_data": {
        "order_id": "5e6ff89e8284e20008276a06",
        "reason": "ROV",
        "evault_id": "5ea85d14f25c1c000fd69c4c"
    },
    "event_time": "2020-04-28 16:43:00.860895"
}

Claim Time Expired Webhook

This webhook will notify your integration whenever an order’s claim time has expired in your account.

{
    "event_type": "claim_time_expired",
    "event_data": {
        "id": "5e9fc270cf1a06000b8c9d38",
        "created": "2020-04-22 04:05:04.468000",
        "status": "Finding Appraisers"
    },
    "event_time": "2020-04-22 12:06:17.293696"
}

Vendor eVault Webhooks

These webhooks notify your integration whenever a document has been uploaded by a vendor to one of your orders. Two events are emitted — a per-file event and an aggregate eVault event:

{
    "event_type": "evault_file_uploaded",
    "event_data": {
        "order_id": "5c4f16764672bb00105ea6y9",
        "evault_id": "5c4f16764672bb00105ea6y2",
        "document_id": "5679d484-d808-11ea-afe3-02401eaec37b",
        "created": "2019-03-17 12:00:00"
    },
    "event_time": "2019-03-17 12:00:00"
}

{
    "event_type": "evault_uploaded",
    "event_data": {
        "id": "5c4f16764672bb00105ea6y2",
        "documents": [{
            "docuemnt_id": "5679d484-d808-11ea-afe3-02401eaec37b",
            "evaut_id": "5c4f16764672bb00105ea6y2",
            "document_name": "Contract.pdf",
            "upload_datetime": "2019-03-17 12:00:00"
        }]
    },
    "event_time": "2019-03-17 12:00:00"
}

Vendor Conversation Webhooks

These webhooks have to do with conversations and the messages that belong to them.

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": "message_sent",
    "event_data": {
        "order_id": "5f318abc22f8af000f0c295b",
        "conversation_id": "5f318ac2aeb817000678c105",
        "message_id": "b752ead9-b1dd-473d-b1b2-ea8d9434f18d",
        "message": "Hi, this is a message",
        "time_stamp": "2020-08-18 18:08:16.600323"
    },
    "event_time": "2020-08-18 18:08:16.600339"
}

Product Webhooks

These webhooks have to do with lender products. We provide webhook events for creation, editing, and deletion of a product. The event data contains the unique product id for programatically syncing lender products with vendor.

Product Created

This webhook will notify your integration anytime a new product is added.

    {
        "event_type": "product_created",
        "event_data": "5e98790e2b76e700134379e1",
        "event_time": "2020-04-16 15:26:06.568873"
    }

Product Updated

This webhook will notify your integration anytime an existing product is edited.

    {
        "event_type": "product_updated",
        "event_data": {
            "product_id": "5e5d61c200828540912a01f7",
            "product_name": "Condo Appraisal Tier 2",
            "amount": "500.00",
            "up_to_amount": null
        },
        "event_time": "2020-03-23 20:28:18.980108"
    }

Product Deleted

This webhook will notify your integration anytime an existing product is deleted.

    {
        "event_type": "product_deleted",
        "event_data": "ecfda5dd64d8f2000c049023",
        "event_time": "2020-05-31 21:40:01.180288"
    }

Payment Webhooks

These webhooks will notify your integration when Reggora collects payment and also when funds are transferred to your Stripe account.

Reggora Collected Funds

This webhook will notify your integration when Reggora has collected funds.

{
    "event_type": "reggora_collected_funds",
    "event_data": {
        "order_id": "5c4f16764672bb00105ea6y9",
        "description": "10 Main Street, Boston MA 02210 (Suffolk County)",
        "expected_transfer_amount": "300.00"
    },
    "event_time": "2022-01-30 15:53:20.000306"
}

Stripe Transfer

This webhook will notify your integration when Reggora transfers funds to your Stripe account.

{
    "event_type": "stripe_funds_transferred_from_reggora",
    "event_data": {
        "order_id": "5c4f16764672bb00105ea6y9",
        "amount": "10.00",
        "description": "10 Main Street, Boston MA 02210 (Suffolk County)",
        "stripe_transaction_id": "py_1KNeoB2e4503XnxukhcIZxH8"
    },
    "event_time": "2022-01-30 15:53:20.000306"
}