Extra Payload Attributes - Document Delivery

These attributes make up the extra payload for the Document Delivery webhook resource for the following events: packagecreated / packageupdated and fulfillmentcreated / fulfillmentupdated

packagecreated / packageupdated Attributes

ATTRIBUTE
groupNamespace string
groupId string
status string
mediaStore string
documentTypes array of strings
recipients.recipientId string
recipients.taskStatuses.taskType string
hasMoreRecipients boolean
fulfillmentScheduledDate string
fulfillmentStatus string

fulfillmentcreated Attributes

ATTRIBUTE
customFields.name sting
customFields.value string
createdDate string
status string

fulfillmentupdated Attributes

ATTRIBUTE
customFields.name sting
customFields.value string
createdDate string
updatedDate string
status string

Webhook Payload Notification Samples

{
  "eventId": "6e348d6a-33db-4539-b074-8eee12e54635",
  "eventTime": "2024-12-12T07:02:39.797Z",
  "eventType": "packagecreated",
  "meta": {
    "resourceType": "DocumentDelivery",
    "resourceId": "1f6849cd-6a86-4fb6-a624-3ddb99ee9e99",
    "instanceId": "tebe11228664",
    "resourceRef": "/delivery/v3/loans/ea96c4ff-0b70-410a-a04a-379cad35bbe8/packages/1f6849cd-6a86-4fb6-a624-3ddb99ee9e99",
    "payload": {
      "groupNamespace": "loans",
      "groupId": "ea96c4ff-0b70-410a-a04a-379cad35bbe8",
      "status": "Created",
      "mediaStore": "SkyDrive",
      "documentTypes": [
        "Coversheet",
        "ESign"
      ],
      "recipients": [
        {
          "recipientId": "10796bd0-0e28-420b-9cf9-f9c7fddb48fa",
          "taskStatuses": [
            {
              "taskType": "ESign"
            }
          ]
        },
        {
          "recipientId": "371bd767-8ff5-4410-b44e-cca5024f707e",
          "taskStatuses": [
            {
              "taskType": "ESign"
            }
          ]
        }
      ],
      "hasMoreRecipients": false,
      "fulfillmentScheduledDate": "2024-12-13T07:02:13Z",
      "fulfillmentStatus": "Scheduled"
    }
  }
}

{
  "eventId": "74a0aea3-aed7-414e-9ee3-ca09bd08f06f",
  "eventTime": "2024-12-12T07:02:39.861Z",
  "eventType": "packageupdated",
  "meta": {
    "resourceType": "DocumentDelivery",
    "resourceId": "1f6849cd-6a86-4fb6-a624-3ddb99ee9e99",
    "instanceId": "tebe11228664",
    "resourceRef": "/delivery/v3/loans/ea96c4ff-0b70-410a-a04a-379cad35bbe8/packages/1f6849cd-6a86-4fb6-a624-3ddb99ee9e99",
    "payload": {
      "groupNamespace": "loans",
      "groupId": "ea96c4ff-0b70-410a-a04a-379cad35bbe8",
      "status": "Created",
      "mediaStore": "SkyDrive",
      "documentTypes": [
        "Coversheet",
        "ESign"
      ],
      "recipients": [
        {
          "recipientId": "10796bd0-0e28-420b-9cf9-f9c7fddb48fa",
          "taskStatuses": [
            {
              "taskType": "ESign"
            }
          ]
        },
        {
          "recipientId": "371bd767-8ff5-4410-b44e-cca5024f707e",
          "taskStatuses": [
            {
              "taskType": "ESign"
            }
          ]
        }
      ],
      "hasMoreRecipients": false,
      "fulfillmentScheduledDate": "2024-12-13T07:02:13Z",
      "fulfillmentStatus": "Scheduled"
    }
  }
}

{
  "eventId": "8aa5bdb6-3350-4c3e-be93-445bc6af1120",
  "eventTime": "2024-12-04T11:03:15.505Z",
  "eventType": "fulfillmentcreated",
  "meta": {
    "resourceType": "DocumentDelivery",
    "resourceId": "3b2af834-44da-4b89-b896-0b7534a1f3ee",
    "instanceId": "tebe11228664",
    "resourceRef": "/fulfillments/v1/packages/3b2af834-44da-4b89-b896-0b7534a1f3ee",
    "payload": {
      "customFields": [
        {
          "name": "LoanId",
          "value": "c1cc9b48-e1b3-4d48-8d04-05b17b09191e"
        }
      ],
      "createdDate": "2024-12-04T11:03:15.469Z",
      "status": "Unprocessed"
    }
  }
}

{
  "eventId": "a60f7a8d-efbb-4c0e-a577-188be24bc51d",
  "eventTime": "2024-12-04T11:03:18.486Z",
  "eventType": "fulfillmentupdated",
  "meta": {
    "userId": "Encompass\\TEBE11228664\\admin",
    "resourceType": "DocumentDelivery",
    "resourceId": "3b2af834-44da-4b89-b896-0b7534a1f3ee",
    "instanceId": "tebe11228664",
    "resourceRef": "/fulfillments/v1/packages/3b2af834-44da-4b89-b896-0b7534a1f3ee",
    "payload": {
      "customFields": [
        {
          "name": "LoanId",
          "value": "c1cc9b48-e1b3-4d48-8d04-05b17b09191e"
        }
      ],
      "createdDate": "2024-12-04T11:03:15.469Z",
      "updatedDate": "2024-12-04T11:03:17Z",
      "status": "Posted"
    }
  }
}