Extra Payload Attributes - ServiceOrder

These attributes make up the extra payload for the ServiceOrder webhook resource for the following events: placed / acknowledged / fulfilled / processfailure / eventreceived / deliveryFailed / fulfillmentFailed

placed / acknowledged / fulfilled / processfailure / eventreceived / deliveryFailed / fulfillmentFailed Attributes

ATTRIBUTE
productListingName string
productId string
partnerId string

Webhook Payload Notification Samples

{
    "eventId": "86e9f5d1-b2f9-4574-b7a1-358f52cad179",
    "eventTime": "2024-11-29T19:07:58.000Z",
    "eventType": "placed",
    "meta": {
        "resourceType": "ServiceOrder",
        "resourceId": "3d0d7644-5c56-474b-9b7d-220eb7bd5e7d",
        "instanceId": "be11172718",
        "resourceRef": "/encompass/v3/loans/f9d69c8a-68f5-4f1f-a9bc-0e92b518c2d5/serviceOrders/3d0d7644-5c56-474b-9b7d-220eb7bd5e7d/history/86e9f5d1-b2f9-4574-b7a1-358f52cad179",
        "payload": {
            "productListingName": "prodlistingname",
            "productId": "5a18ae90-6a04-4df9-9883-cbba41785f3d",
            "partnerId": "007001"
        }
    }
}

{
    "eventId": "0fd31b80-c973-4e97-a27b-8517dcae4b79",
    "eventTime": "2024-11-29T19:11:28.000Z",
    "eventType": "acknowledged",
    "meta": {
        "resourceType": "ServiceOrder",
        "resourceId": "3d0d7644-5c56-474b-9b7d-220eb7bd5e7d",
        "instanceId": "be11172718",
        "resourceRef": "/encompass/v3/loans/f9d69c8a-68f5-4f1f-a9bc-0e92b518c2d5/serviceOrders/3d0d7644-5c56-474b-9b7d-220eb7bd5e7d/history/0fd31b80-c973-4e97-a27b-8517dcae4b79",
        "payload": {
            "productListingName": "prodlistingname",
            "productId": "5a18ae90-6a04-4df9-9883-cbba41785f3d",
            "partnerId": "007001"
        }
    }
}

{
    "eventId": "b9b0078e-8dbf-4cf4-b6ca-b347e065ecbc",
    "eventTime": "2024-11-29T19:11:50.000Z",
    "eventType": "fulfilled",
    "meta": {
        "resourceType": "ServiceOrder",
        "resourceId": "3d0d7644-5c56-474b-9b7d-220eb7bd5e7d",
        "instanceId": "be11172718",
        "resourceRef": "/encompass/v3/loans/f9d69c8a-68f5-4f1f-a9bc-0e92b518c2d5/serviceOrders/3d0d7644-5c56-474b-9b7d-220eb7bd5e7d/history/b9b0078e-8dbf-4cf4-b6ca-b347e065ecbc",
        "payload": {
            "productListingName": "prodlistingname",
            "productId": "5a18ae90-6a04-4df9-9883-cbba41785f3d",
            "partnerId": "007001"
        }
    }
}

{
    "eventId": "4585061f-f2c4-4119-86a1-0412bffce548",
    "eventTime": "2024-11-29T19:49:07.000Z",
    "eventType": "processfailure",
    "meta": {
        "resourceType": "ServiceOrder",
        "resourceId": "eeef2025-ea3c-4fe4-9518-ad8ab1f61f28",
        "instanceId": "be11172718",
        "resourceRef": "/encompass/v3/loans/de33838d-e13a-49cc-9aea-c47dbab2e25b/serviceOrders/eeef2025-ea3c-4fe4-9518-ad8ab1f61f28/history/4585061f-f2c4-4119-86a1-0412bffce548",
        "payload": {
            "productListingName": "listing name",
            "productId": "939f106d-d397-4b5d-8994-54d043dcf2bf",
            "partnerId": "007001"
        }
    }
}

{
    "eventId": "64c0cfa8-b2b1-4369-8b4d-48c95f923eaf",
    "eventTime": "2024-11-29T19:36:34.000Z",
    "eventType": "eventreceived",
    "meta": {
        "resourceType": "ServiceOrder",
        "resourceId": "98ffbee6-76e4-4939-8a76-f669fedfec6b",
        "instanceId": "be11172718",
        "resourceRef": "/encompass/v3/loans/7c3ca2ae-d3d1-4086-ab32-4e389282ecfb/serviceOrders/98ffbee6-76e4-4939-8a76-f669fedfec6b/history/64c0cfa8-b2b1-4369-8b4d-48c95f923eaf",
        "payload": {
            "productListingName": "TestProductName",
            "productId": "5a18ae90-6a04-4df9-9883-cbba41785f3d",
            "partnerId": "007001"
        }
    }
}

{
  "eventId": "e173e4f1-0b75-4820-9338-82509667f03c",
  "eventTime": "2024-04-05T18:11:52.000Z",
  "eventType": "deliveryFailed",
  "meta": {
    "resourceType": "ServiceOrder",
    "resourceId": "88f0e5fe-b160-4786-8138-6038e9c1759d",
    "instanceId": "debe11136164",
    "resourceRef": "/encompass/v3/loans/{loanId}/serviceOrders/{serviceOrderId}/history/{eventId}",
    "payload": {
      "productListingName": "Sample EPC product",
      "productId": "xxxxxxxxxx",
      "partnerId": "xxxxxxx"
    }
  }
}

{
  "eventId": "e173e4f1-0b75-4820-9338-82509667f03c",
  "eventTime": "2024-04-05T18:11:52.000Z",
  "eventType": "fulfillmentFailed",
  "meta": {
    "resourceType": "ServiceOrder",
    "resourceId": "88f0e5fe-b160-4786-8138-6038e9c1759d",
    "instanceId": "debe11136164",
    "resourceRef": "/encompass/v3/loans/{loanId}/serviceOrders/{serviceOrderId}/history/{eventId}",
    "payload": {
      "productListingName": "Sample EPC product",
      "productId": "xxxxxxxxxx",
      "partnerId": "xxxxxxx"
    }
  }
}