Guides

Events

Suggest Edits

Structure

{
      "event_id": string,
      "subscription_id": string,
      "closing_uuid": string,
      "event_name": string,
      "signing_method": string,
      "created_at": unix epoch time (seconds),
      "payload": {
        "external_identifiers": [
          // external identifiers, can be empty
        ]
        // other fields of the event.
      }
    }
  1. event_id: unique identifier of the event
  2. subscription_id: identifier of the subscription
  3. closing_uuid: uuid of closing.
  4. event_name: name of event
  5. signing_method: can be "wet_only", "hybrid", "hybrid_with_enote", "full_eclosing", "full_eclosing_with_enote", Create a new closing
  6. created_at: the epoch timestamp of the event
  7. payload: the payload JSON object of the event.
    • external_identifiers: JSON array of the external identifiers of the closing. If the closing was created with external identifiers Create a new closing, they will be included in the array, otherwise the array is empty.
    • other fields: some events have additional data, for example, the borrower UUID.

Borrower Preview Events

Integrate with Borrower Preview Events 

{
      "event_id": "b85e055a-57c5-4968-b742-e4180913a349",
      "subscription_id": "e040c30e-dfe4-49c3-933e-9781cf70a764",
      "closing_uuid": "7e22f055-2e77-4234-accb-df953801eac1",
      "event_name": "borrower.preview_available",
      "signing_method": "hybrid",
      "created_at": 1656524428,
      "payload": {
        "external_identifiers": [
         ...
        ],
        "borrower_uuid": "95e7638b-93a8-27de-4243-3d46e5b942a5"
      }
    }

{
      "event_id": "2a7b8734-f944-4963-b23e-cffbea59cde9",
      "subscription_id": "e040c30e-dfe4-49c3-933e-9781cf70a764",
      "closing_uuid": "8ca4bfe2-7beb-45c2-9182-9c3bcf4dc37e",
      "event_name": "borrower.preview_complete",
      "signing_method": "hybrid",
      "created_at": 1655817730,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
    }

{
      "event_id": "25146b6b-c46d-417c-90e2-da7df4737a2e",
      "subscription_id": "2afae178-498d-4f19-8857-279bf25e06d3",
      "closing_uuid": "23242df7-f83e-4b5e-a30d-56b520e62056",
      "event_name": "borrower.redraw_preview_available",
      "signing_method": "hybrid",
      "created_at": 1655161244,
      "payload": {
        "external_identifiers": [
          ...
        ],
        "borrower_uuid": "78986eab-39e4-78db-b733-eda256b53274"
      }
    }

Borrower eSign Events

Integrate with Borrower eSign Events

{
      "event_id": "9bf64f7c-1e3e-4d1b-84d5-5e95c95dd0d5",
      "subscription_id": "f2012e25-4388-432e-b53d-01236cdb159a",
      "closing_uuid": "6be819e3-8ef5-4d84-833d-8102adbe8273",
      "event_name": "borrower.esigning_available",
      "signing_method": "hybrid",
      "created_at": 1654741164,
      "payload": {
        "external_identifiers": [
          ...
        ],
        "borrower_uuid": "729452a7-ae89-42d7-98ae-4d7365b6b83e"
      }
    }

{
      "event_id": "d54e2bb1-540a-47fe-bae9-ae119d1fc879",
      "subscription_id": "e040c30e-dfe4-49c3-933e-9781cf70a764",
      "closing_uuid": "500a54ef-ccf3-4b46-ab0c-2f571b5db503",
      "event_name": "borrower.esigning_complete",
      "signing_method": "hybrid",
      "created_at": 1656684029,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
    }

{
	"event_id": "0337e34c-1acd-4b6a-afab-cacca4b605a4",
        "subscription_id": "2afae178-498d-4f19-8857-279bf25e06d3",
	"closing_uuid": "878b5a9d-4d96-a8e8-b4a9-ae5b37273624",
	"event_name": "borrower.redraw_esigning_available",
	"signing_method": "hybrid",
	"created_at": 1644432694,
	"payload": {
		"external_identifiers": [],
		"borrower_uuid": "8d89b65a-3764-d2e2-a5d8-2e9b58ad3427"
	}
}

{
      "event_id": "28e430b1-b33d-4575-b875-110d8bf185df",
      "subscription_id": "2afae178-498d-4f19-8857-279bf25e06d3",
      "closing_uuid": "7edbc5c2-b665-49b8-9d15-da5ddcccd1b1",
      "event_name": "borrower.esign_reminder",
      "signing_method": "hybrid",
      "created_at": 1655257575,
      "payload": {
        "external_identifiers": [
         ...
        ],
        "borrower_uuid": "385a6eb9-45b2-37d6-6a44-7d8e96a37842",
        "trigger": "automated",
        "reminder_type": "email"
      }
    }
  1. trigger: manual or automatic
  2. reminder_type: email

Borrower Events

Integrate with Borrower Events

{
      "event_id": "7b5a1ccd-488e-4a51-8374-b24da4cccf83",
      "subscription_id": "f2012e25-4388-432e-b53d-01236cdb159a",
      "closing_uuid": "a367a76e-a036-47cd-ac1e-c7932ef9c687",
      "event_name": "borrower.opted_out",
      "signing_method": "wet_only",
      "created_at": 1656533310,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
   }

{
      "event_id": "ebb6c143-a26b-4ba6-9d97-83240df17d26",
      "subscription_id": "f2012e25-4388-432e-b53d-01236cdb159a",
      "closing_uuid": "a367a76e-a036-47cd-ac1e-c7932ef9c687",
      "event_name": "borrower.opted_in",
      "signing_method": "hybrid",
      "created_at": 1656533378,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
    }

Closing Events

Integrate with Closing Events

{
      "event_id": "2b48395e-f1e0-482e-842b-9cedbd37ac7b",
      "subscription_id": "f2012e25-4388-432e-b53d-01236cdb159a",
      "closing_uuid": "500a54ef-ccf3-4b46-ab0c-2f571b5db503",
      "event_name": "closing.completed",
      "signing_method": "hybrid",
      "created_at": 1656684040,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
    }

 {
      "event_id": "c997b0b2-40d7-4190-8484-76bc68a68d3c",
      "subscription_id": "e040c30e-dfe4-49c3-933e-9781cf70a764",
      "closing_uuid": "500a54ef-ccf3-4b46-ab0c-2f571b5db503",
      "event_name": "closing.created",
      "signing_method": "hybrid",
      "created_at": 1656683649,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
    }

{
      "event_id": "99f28b08-8991-40ea-b3fe-19616776d308",
      "subscription_id": "f2012e25-4388-432e-b53d-01236cdb159a",
      "closing_uuid": "6be819e3-8ef5-4d84-833d-8102adbe8273",
      "event_name": "closing.canceled",
      "signing_method": "hybrid",
      "created_at": 1654741233,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
    }

{
	"event_id": "0ca41d68-4e31-4460-8f8b-3bfd9081217c",
	"subscription_id": "34d047d1-d29b-4837-ab6f-18b060a4290a",
	"closing_uuid": "1237f99f-9685-448d-a0fb-605655027144",
	"event_name": "closing.created_from_redraw",
	"signing_method": "hybrid",
	"created_at": 1655412862,
	"payload": {
		"external identifiers": [],
		"linked_closing_by_redraw_uuid": "d896e48b-0b71-4e31-aadd-dd50d20ea904"
	}
}
  1. linked_closing_by_redraw_uuid: the UUID of the original closing (canceled due to full redraw)
{
	"event_id": "fb5383f4-1109-4b6f-9822-bb59da8652d8",
	"subscription_id": "34d047d1-d29b-4837-ab6f-18b060a4290a",
	"closing_uuid": "d896e48b-0b71-4e31-aadd-dd50d20ea904",
	"event_name": "closing.canceled_for_full_redraw",
	"signing_method": "hybrid",
	"created_at": 1655412863,
	"payload": {
		"external_identifiers": [],
		"linked_closing_by_redraw_uuid": "1237f99f-9685-448d-a0fb-605655827144"
	}
}
  1. linked_closing_by_redraw_uuid: the UUID of the new closing due to redraw
{
      "event_id": "152b5eda-9ff0-4e08-b112-6eaeacf148e2",
      "subscription_id": "2afae178-498d-4f19-8857-279bf25e06d3",
      "closing_uuid": "32f1624f-5143-4010-98c5-593dcd2407da",
      "event_name": "closing.type_converted",
      "signing_method": "wet_only",
      "created_at": 1655229527,
      "payload": {
        "external_identifiers": [
          ...
        ],
        "converted_from": "hybrid",
        "converted_to": "wet_only",
        "converted_by": "lender"
      }
    }
  1. converted_from: the original signing method, refer to Create a new closing for the signing method values
  2. converted_to: the new signing method, refer to Create a new closing for the signing method values.
  3. converted_by: settlement agent or lender
{
      "event_id": "dd9fa380-4925-4d41-84ef-4b3723b82b68",
      "subscription_id": "e040c30e-dfe4-49c3-933e-9781cf70a764",
      "closing_uuid": "a1a946a0-c673-4ffa-a6fe-d13fd60e7fbf",
      "event_name": "closing.appointment_details_changed",
      "signing_method": "hybrid",
      "created_at": 1656532871,
      "payload": {
        "external_identifiers": [
         ..
        ]
      }
    }

Document Events

Integrate with Document Events 

{
      "event_id": "497e0c55-757b-482a-81b5-1bbf53277587",
      "subscription_id": "e040c30e-dfe4-49c3-933e-9781cf70a764",
      "closing_uuid": "500a54ef-ccf3-4b46-ab0c-2f571b5db503",
      "event_name": "document.created",
      "signing_method": "hybrid",
      "created_at": 1656684343,
      "payload": {
        "external_identifiers": [
          ...
        ],
        "document_uuid": "729452a7-ae89-42d7-b5a8-d7365b6b83eb",
        "document_type": "signed complete package"
      }
    }

Mobile Notary Events

Integrate with Mobile Notary Events 

{
      "event_id": "426d3fc6-9379-47f8-aa48-8183f4da6e86",
      "subscription_id": "5e8ca921-85c1-4819-a229-19bd6351e8e7",
      "closing_uuid": "9d1efc56-a58e-41bf-8ee3-1cb94ce1ae0d",
      "event_name": "notary.order_created",
      "signing_method": "hybrid",
      "created_at": 1657242464,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
    }

{
      "event_id": "ace6b917-cd0f-465a-94b5-fdfe457dca0e",
      "subscription_id": "5e8ca921-85c1-4819-a229-19bd6351e8e7",
      "closing_uuid": "9d1efc56-a58e-41bf-8ee3-1cb94ce1ae0d",
      "event_name": "notary.assigned",
      "signing_method": "hybrid",
      "created_at": 1657242622,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
    }

{
      "event_id": "303e8fda-3335-443a-b059-0630637f603b",
      "subscription_id": "5e8ca921-85c1-4819-a229-19bd6351e8e7",
      "closing_uuid": "9d1efc56-a58e-41bf-8ee3-1cb94ce1ae0d",
      "event_name": "notary.appointment_confirmation_status_changed",
      "signing_method": "hybrid",
      "created_at": 1657242881,
      "payload": {
        "external_identifiers": [
          ...
        ]
      },
      "status": "confirmed"
    }

{
      "event_id": "29782d80-6238-437b-82ec-8fd22470460e",
      "subscription_id": "5e8ca921-85c1-4819-a229-19bd6351e8e7",
      "closing_uuid": "9d1efc56-a58e-41bf-8ee3-1cb94ce1ae0d",
      "event_name": "notary.order_canceled",
      "signing_method": "hybrid",
      "created_at": 1657243119,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
    }

{
      "event_id": "716624d8-1548-441b-b4f5-9a1e672a8c61",
      "subscription_id": "5e8ca921-85c1-4819-a229-19bd6351e8e7",
      "closing_uuid": "9d1efc56-a58e-41bf-8ee3-1cb94ce1ae0d",
      "event_name": "notary.order_completed",
      "signing_method": "hybrid",
      "created_at": 1657243300,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
    }

{
      "event_id": "8f4a05bb-6f3a-448e-9766-eb6d64dd33fc",
      "subscription_id": "5e8ca921-85c1-4819-a229-19bd6351e8e7",
      "closing_uuid": "3c7d1644-db1a-4203-8d6e-ad30401ca207",
      "event_name": "notary.order_did_not_sign",
      "signing_method": "hybrid",
      "created_at": 1657243656,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
    }

{
      "event_id": "ed3a4f90-7423-4d64-82db-4f0faa17dfca",
      "subscription_id": "5e8ca921-85c1-4819-a229-19bd6351e8e7",
      "closing_uuid": "9d1efc56-a58e-41bf-8ee3-1cb94ce1ae0d",
      "event_name": "notary.attachment_delivery_status_changed",
      "signing_method": "hybrid",
      "created_at": 1657242622,
      "payload": {
        "external_identifiers": [
          ...
        ]
      },
      "status": "sent_by_client"
    }
Status valueStatus Meaning
nulldocs have not been sent
sent_by_clientdocs sent through API or by client
emailed_to_notarydocs emailed by scheduler
direct_linksdocs emailed by scheduler
notary_picked_up_docsdocs not emailed
overnighteddocs not emailed
at_closingdocs not emailed
downloadeddocs were emailed and notary has downloaded all of them
{
      "event_id": "92eb7336-aef8-47b7-a544-f6c971e78258",
      "subscription_id": "5e8ca921-85c1-4819-a229-19bd6351e8e7",
      "closing_uuid": "9d1efc56-a58e-41bf-8ee3-1cb94ce1ae0d",
      "event_name": "notary.appointment_confirmed",
      "signing_method": "hybrid",
      "created_at": 1657242881,
      "payload": {
        "external_identifiers": [
          ...
        ]
      }
    }

unconfirmed
confirmed
change_requested

Updated about 2 years ago