Extra Payload Attributes - DocumentOrder

This attribute makes up the extra payload for the DocumentOrder webhook resource for the following events:

ATTRIBUTE
loanId string

Opening Audit / Order / Delivery Events

openingauditcompleted
openingauditfailed
openingordercompleted
openingorderfailed
openingdeliverycompleted
openingdeliveryfailed

Webhook Payload Notification Samples

{
    "eventId": "3f0c8e83-cb47-4af7-a097-43b85e54184e",
    "eventTime": "2024-11-11T07:01:47.088Z",
    "eventType": "openingauditcompleted",
    "meta": {
        "userId": "5313731050",
        "resourceType": "DocumentOrder",
        "resourceId": "6faceaba-4941-4f3a-af96-1248c9e3d3ff",
        "instanceId": "tebe11228664",
        "resourceRef": "encompassdocs/v1/documentAudits/opening/6faceaba-4941-4f3a-af96-1248c9e3d3ff",
        "payload": {
            "loanId": "6729430d-bac5-4b58-8daf-e1a8a120fcbf"
        }
    }
}

{
    "eventId": "4945e56b-9eda-4da0-bce9-c832421528f8",
    "eventTime": "2024-11-11T07:41:47.638Z",
    "eventType": "openingauditfailed",
    "meta": {
        "userId": "admin",
        "resourceType": "DocumentOrder",
        "resourceId": "a99f1e5f-de53-43c1-ac74-d86b3bbd3777",
        "instanceId": "tebe11228664",
        "resourceRef": "encompassdocs/v1/documentAudits/opening/a99f1e5f-de53-43c1-ac74-d86b3bbd3777",
        "payload": {
            "loanId": "768139b5-fc15-4ed0-8862-f9a7b52f40c0"
        }
    }
}

{
    "eventId": "f3cc16c8-f433-43cf-92ea-d2bfd52ec86c",
    "eventTime": "2024-11-11T07:02:06.992Z",
    "eventType": "openingordercompleted",
    "meta": {
        "userId": "5313731050",
        "resourceType": "DocumentOrder",
        "resourceId": "faf4324e-0c5a-4f04-b489-c4819f612de9",
        "instanceId": "tebe11228664",
        "resourceRef": "encompassdocs/v1/documentOrders/opening/faf4324e-0c5a-4f04-b489-c4819f612de9",
        "payload": {
            "loanId": "6729430d-bac5-4b58-8daf-e1a8a120fcbf"
        }
    }
}

{
  "eventId": "4a64c768-956b-4078-a6f0-e6f02a61171d",
  "eventTime": "2024-11-11T07:43:56.749Z",
  "eventType": "openingorderfailed",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "5f4660c4-46fe-48a8-a886-75bb2126af05",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/opening/5f4660c4-46fe-48a8-a886-75bb2126af05",
    "payload": {
      "loanId": "768139b5-fc15-4ed0-8862-f9a7b52f40c0"
    }
  }
}

{
  "eventId": "690e8449-e9a2-4cd7-8135-da67622776ed",
  "eventTime": "2024-11-11T07:02:31.623Z",
  "eventType": "openingdeliverycompleted",
  "meta": {
    "userId": "5313731050",
    "resourceType": "DocumentOrder",
    "resourceId": "e1274315-8cf7-4429-af67-0113fc61c966",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/opening/faf4324e-0c5a-4f04-b489-c4819f612de9/delivery/e1274315-8cf7-4429-af67-0113fc61c966",
    "payload": {
      "loanId": "6729430d-bac5-4b58-8daf-e1a8a120fcbf"
    }
  }
}

{
  "eventId": "fd38c2ca-dddf-48b4-b5b3-7e51d1847cfe",
  "eventTime": "2024-11-11T07:45:23.595Z",
  "eventType": "openingdeliveryfailed",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "3f2556bd-fb89-48a2-9b2b-728d7741297e",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/opening/5f4660c4-46fe-48a8-a886-75bb2126af05/delivery/3f2556bd-fb89-48a2-9b2b-728d7741297e",
    "payload": {
      "loanId": "768139b5-fc15-4ed0-8862-f9a7b52f40c0"
    }
  }
}

Closing Audit / Order / Delivery Events

closingauditcompleted
closingordercompleted
closingdeliverycompleted
closingdeliveryfailed

Webhook Payload Notification Samples

{
  "eventId": "1b1d54f9-5732-4333-a6c7-1011e88a170a",
  "eventTime": "2024-11-11T08:18:53.925Z",
  "eventType": "closingauditcompleted",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "7250fffe-c540-47a2-9bb2-7362f22fffd6",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentAudits/closing/7250fffe-c540-47a2-9bb2-7362f22fffd6",
    "payload": {
      "loanId": "768139b5-fc15-4ed0-8862-f9a7b52f40c0"
    }
  }
}

{
  "eventId": "418c1bf4-491e-49b3-8698-f21e1bd1955f",
  "eventTime": "2024-11-11T08:21:20.106Z",
  "eventType": "closingordercompleted",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "24583bee-f0d1-4baf-a2d6-c2dc4d9182fb",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/closing/24583bee-f0d1-4baf-a2d6-c2dc4d9182fb",
    "payload": {
      "loanId": "768139b5-fc15-4ed0-8862-f9a7b52f40c0"
    }
  }
}

{
  "eventId": "544ddb17-3fdf-427c-8d59-a8514f7de741",
  "eventTime": "2024-11-11T08:23:04.941Z",
  "eventType": "closingdeliverycompleted",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "bb5d993e-4e5d-43b5-8b29-498a81146b6b",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/closing/24583bee-f0d1-4baf-a2d6-c2dc4d9182fb/delivery/bb5d993e-4e5d-43b5-8b29-498a81146b6b",
    "payload": {
      "loanId": "768139b5-fc15-4ed0-8862-f9a7b52f40c0"
    }
  }
}

{
  "eventId": "431af88d-8dba-4723-a3b7-9e07b2aefd91",
  "eventTime": "2024-11-11T08:24:25.560Z",
  "eventType": "closingdeliveryfailed",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "6034b495-6672-4e98-96ef-6c65a4b267ba",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/closing/24583bee-f0d1-4baf-a2d6-c2dc4d9182fb/delivery/6034b495-6672-4e98-96ef-6c65a4b267ba",
    "payload": {
      "loanId": "768139b5-fc15-4ed0-8862-f9a7b52f40c0"
    }
  }
}

Forms Events

formscompleted
formsdeliverycompleted
formsdeliveryfailed

Webhook Payload Notification Samples

{
  "eventId": "6e3d9e97-e6fa-43cf-896c-4fda557d7607",
  "eventTime": "2024-11-11T07:22:27.335Z",
  "eventType": "formscompleted",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "b7abea37-fc30-45f9-b12d-85bcafad4f44",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/forms/b7abea37-fc30-45f9-b12d-85bcafad4f44",
    "payload": {
      "loanId": "69bfc5e4-c176-4bdb-958c-1bd8336d5211"
    }
  }
}

{
  "eventId": "9b11bc14-73b1-418c-a071-54f1a9ddea70",
  "eventTime": "2024-11-11T07:32:17.150Z",
  "eventType": "formsdeliverycompleted",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "6652069c-0d81-4017-99c9-95d99b80c9cb",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/forms/60c945f5-3042-4491-a0e0-07cec08cf4cc/delivery/6652069c-0d81-4017-99c9-95d99b80c9cb",
    "payload": {
      "loanId": "1c16218b-503f-40f5-8815-f3797b8fd4c3"
    }
  }
}

{
  "eventId": "60eac597-4d7d-4cd9-9829-2cf9e63978f4",
  "eventTime": "2024-11-11T07:50:33.846Z",
  "eventType": "formsdeliveryfailed",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "602b2491-7b4e-44ad-bcde-341375dd123b",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/forms/5079c215-99eb-45d4-aaf4-501fc565480d/delivery/602b2491-7b4e-44ad-bcde-341375dd123b",
    "payload": {
      "loanId": "768139b5-fc15-4ed0-8862-f9a7b52f40c0"
    }
  }
}

Opening Append / Add To Documents and eFolder Events

openingappenddocumentssucceeded
openingaddtoefoldersucceeded

Webhook Payload Notification Samples

{
  "eventId": "fd1a4b2c-6da8-463f-8c47-f34392626d54",
  "eventTime": "2024-11-11T07:30:16.483Z",
  "eventType": "openingappenddocumentssucceeded",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "d6bd18e1-ff65-4bc3-a27d-43c98b9c05f7",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/opening/3cab2a7e-16b4-4842-86c6-ada0b83db57c/documents/d6bd18e1-ff65-4bc3-a27d-43c98b9c05f7",
    "payload": {
      "loanId": "1c16218b-503f-40f5-8815-f3797b8fd4c3"
    }
  }
}

{
  "eventId": "6feb40af-d1b2-4184-b032-37d3be2e4458",
  "eventTime": "2024-11-11T07:07:31.167Z",
  "eventType": "openingaddtoefoldersucceeded",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "688aedd9-73f8-41ff-aec8-bf1b81b5e53e",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/opening/2ef6fa78-726d-485f-a752-307daba4f553/addToEFolder/688aedd9-73f8-41ff-aec8-bf1b81b5e53e",
    "payload": {
      "loanId": "ec793725-d43b-4e60-945b-ebb261be3208"
    }
  }
}

Closing Append / Add To Documents and eFolder Events

closingaddtoefoldersucceeded
closingaddtoefolderfailed

Webhook Payload Notification Samples

{
  "eventId": "f8add86d-32f1-4759-8e38-16e3b3d95e42",
  "eventTime": "2024-11-11T08:27:53.679Z",
  "eventType": "closingaddtoefoldersucceeded",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "adecf4c5-8e85-4180-a59b-39ca4ace9aae",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/closing/24583bee-f0d1-4baf-a2d6-c2dc4d9182fb/addToEFolder/adecf4c5-8e85-4180-a59b-39ca4ace9aae",
    "payload": {
      "loanId": "768139b5-fc15-4ed0-8862-f9a7b52f40c0"
    }
  }
}


{
  "eventId": "ff404a71-ba7e-46ad-91fb-c8ab2f1fd514",
  "eventTime": "2024-11-11T08:29:20.960Z",
  "eventType": "closingaddtoefolderfailed",
  "meta": {
    "userId": "admin",
    "resourceType": "DocumentOrder",
    "resourceId": "8d0637cd-c9c9-44ba-a644-bd1e1c56934b",
    "instanceId": "tebe11228664",
    "resourceRef": "encompassdocs/v1/documentOrders/closing/24583bee-f0d1-4baf-a2d6-c2dc4d9182fb/addToEFolder/8d0637cd-c9c9-44ba-a644-bd1e1c56934b",
    "payload": {
      "loanId": "768139b5-fc15-4ed0-8862-f9a7b52f40c0"
    }
  }
}