Description
Hi Marley supports webhooks that will post case data as a JSON payload during specific case events to a designated HTTP(s) Address; more specifically (Gray) Inline messages that appear just to the adjuster in Chat workflows.
Case Events
The current list of Case Events are defined below.
|
Event |
Description |
|
total_loss.assignment_created |
Copart assignment created |
|
total_loss.vehicle_checked_in |
Vehicle checked in at Copart Yard |
|
total_loss.release_issue.created |
Release Issue - Verbal Release Required |
|
total_loss.release_issue.completed |
Release Issue Completed |
|
total_loss.release_issue.updated |
Release Issue Updated |
|
total_loss.release_issue.resolved |
Release Issue Resolved |
|
title_express.request_created |
The Title Express Request has been Created |
|
survey.initiated |
The Hi Marley Survey has been initiated |
|
survey.exited |
The Contact has exited the Hi Marley Survey workflow |
|
survey.complete |
The Hi Marley Survey workflow has been completed |
Case Event Payload
{
"caseData": {
"brand": "Hi Marley",
"claimNumber": "12123515",
"dateOfLoss": "2021-07-23T16:00:00.000Z",
"id": "5164e03e-22dd-4a95-b79e-81d04e48b0a3",
"archived": false
},
"state": "open",
"caseType": "claim",
"customer": {
"id": "a5d6206b-7b58-4b09-823f-35516b199821",
"first": "Smith",
"last": "John",
"email": "customer8013@testemail.com",
"mobile": "+555555555",
"role": "enduser",
"optStatus": true,
"optStatusDetail": "OPTED_IN"
},
"primaryContact": {
"id": "20764b4a-0fe4-4bae-a100-40276b2d4d45",
"first": "Carrier",
"last": "Adjuster",
"email": "carrier.adjuster@carrier.org",
"role": "operator"
},
"createTime": "2021-07-30T19:38:51.744Z",
"referenceId": "12123515",
"privacy": "public",
"marleyNumber": "+17252279925",
"languagePreference": "en",
"secondaryOperators": [],
"event": {
"type": "<EVENT>.<SUBEVENT>.<STATUS>", //if 2 values then delimited by underscore '_'. if 3 values delimited by period '.'
"body": "Content of Event", // free form text, can change
"eventTime": "2023-04-19T18:58:23.022Z",
"details": {
"id": "UUID for Event", //will always be constant/static value throughout the course of events. Copart UUID. Will be used for activities in GW.
"code": "Event Code Enum", // enum
"description": "Event Description",
"timestamp": "2023-04-19T18:58:23.022Z"
}
}
}
Event Payloads
total_loss.assignment_created
{
"caseData": {
"id": "f02642d0-34cb-4800-b123-b581a789648f",
"archived": false,
"claimNumber": "555666777",
"dateOfLoss": "2024-06-01T16:00:00.000Z",
"brand": "Lovable Insurance"
},
"state": "open",
"caseType": "claim",
"customer": {
"id": "69226ab8-db02-4b67-b1b7-7eaf1ff2d5f5",
"first": "Test",
"last": "Events",
"email": "",
"mobile": "+15552093482",
"role": "enduser",
"optStatus": true,
"optStatusDetail": "OPTED_IN"
},
"primaryContact": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createdBy": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createTime": "2024-06-05T14:34:56.656Z",
"creationSource": "WebApp",
"referenceId": "555666777",
"privacy": "public",
"marleyNumber": "+17627951807",
"languagePreference": "en",
"secondaryOperators": [
{
"id": "a3a278ec-0ff1-46b3-80ce-a3abf96358f2",
"first": "Steven",
"last": "Colon",
"email": "steven.colon@himarley.com",
"role": "operator"
}
],
"isTotalLoss": true,
"releaseIssues": [],
"totalLossData": {
"stockNumber": "123456789",
"sellerCode": "TestSellerCode",
"companyCode": "PLY",
"vehicleLocation": {
"addressLine1": "1234 ADDRESS RD",
"addressLine2": "",
"city": "CITY",
"zipCode": "11111",
"companyName": "COMPANY NAME",
"contactPhone": "8885552222",
"type": "Shop"
},
"vehicleDetails": {
"make": "MAKE",
"model": "MODEL",
"color": "COLOR",
"year": 1999,
"licensePlateNumber": ""
},
"ownerDetails": {
"firstName": "Test",
"lastName": "Events",
"phoneNumber": "5552093482"
}
},
"event": {
"type": "total_loss.assignment_created",
"body": "Copart Assignment Created",
"eventTime": "2024-06-05T14:40:09Z"
}
}
total_loss.vehicle_checked_in
{
"caseData": {
"id": "f02642d0-34cb-4800-b123-b581a789648f",
"archived": false,
"claimNumber": "555666777",
"dateOfLoss": "2024-06-01T16:00:00.000Z",
"brand": "Lovable Insurance"
},
"state": "open",
"caseType": "claim",
"customer": {
"id": "69226ab8-db02-4b67-b1b7-7eaf1ff2d5f5",
"first": "Test",
"last": "Events",
"email": "",
"mobile": "+15552093482",
"role": "enduser",
"optStatus": true,
"optStatusDetail": "OPTED_IN"
},
"primaryContact": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createdBy": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createTime": "2024-06-05T14:34:56.656Z",
"creationSource": "WebApp",
"referenceId": "555666777",
"privacy": "public",
"marleyNumber": "+17627951807",
"languagePreference": "en",
"secondaryOperators": [
{
"id": "a3a278ec-0ff1-46b3-80ce-a3abf96358f2",
"first": "Steven",
"last": "Colon",
"email": "steven.colon@himarley.com",
"role": "operator"
}
],
"isTotalLoss": true,
"releaseIssues": [
{
"id": "12345",
"status": "RESOLVED",
"code": "VRRLR",
"description": "Verbal Release Required",
"comment": "comment",
"resolved": true,
"timestamp": "2024-06-05T14:42:59.000Z"
}
],
"totalLossData": {
"stockNumber": "123456789",
"sellerCode": "TestSellerCode",
"companyCode": "PLY",
"vehicleLocation": {
"addressLine1": "1234 ADDRESS RD",
"addressLine2": "",
"city": "CITY",
"zipCode": "11111",
"companyName": "COMPANY NAME",
"contactPhone": "8885552222",
"type": "Shop"
},
"vehicleDetails": {
"make": "MAKE",
"model": "MODEL",
"color": "COLOR",
"year": 1999,
"licensePlateNumber": ""
},
"ownerDetails": {
"firstName": "Test",
"lastName": "Events",
"phoneNumber": "5552093482"
}
},
"event": {
"type": "total_loss.vehicle_checked_in",
"body": "Vehicle Checked in at Copart Yard",
"eventTime": "2024-06-05T14:46:38Z"
}
}
total_loss.release_issue.created
{
"caseData": {
"id": "f02642d0-34cb-4800-b123-b581a789648f",
"archived": false,
"claimNumber": "555666777",
"dateOfLoss": "2024-06-01T16:00:00.000Z",
"brand": "Lovable Insurance"
},
"state": "open",
"caseType": "claim",
"customer": {
"id": "69226ab8-db02-4b67-b1b7-7eaf1ff2d5f5",
"first": "Test",
"last": "Events",
"email": "",
"mobile": "+15552093482",
"role": "enduser",
"optStatus": true,
"optStatusDetail": "OPTED_IN"
},
"primaryContact": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createdBy": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createTime": "2024-06-05T14:34:56.656Z",
"creationSource": "WebApp",
"referenceId": "555666777",
"privacy": "public",
"marleyNumber": "+17627951807",
"languagePreference": "en",
"secondaryOperators": [
{
"id": "a3a278ec-0ff1-46b3-80ce-a3abf96358f2",
"first": "Steven",
"last": "Colon",
"email": "steven.colon@himarley.com",
"role": "operator"
}
],
"isTotalLoss": true,
"releaseIssues": [],
"totalLossData": {
"stockNumber": "123456789",
"sellerCode": "TestSellerCode",
"companyCode": "PLY",
"vehicleLocation": {
"addressLine1": "1234 ADDRESS RD",
"addressLine2": "",
"city": "CITY",
"zipCode": "11111",
"companyName": "COMPANY NAME",
"contactPhone": "8885552222",
"type": "Shop"
},
"vehicleDetails": {
"make": "MAKE",
"model": "MODEL",
"color": "COLOR",
"year": 1999,
"licensePlateNumber": ""
},
"ownerDetails": {
"firstName": "Test",
"lastName": "Events",
"phoneNumber": "5552093482"
}
},
"event": {
"type": "total_loss.release_issue.created",
"body": "Release Issue - Verbal Release Required",
"eventTime": "2024-06-05T14:55:59Z",
"details": {
"id": "12345",
"code": "VRRLR",
"description": "Verbal Release Required",
"timestamp": "2024-06-05T14:42:59.000Z"
}
}
}
total_loss.release_issue.completed
{
"caseData": {
"id": "f02642d0-34cb-4800-b123-b581a789648f",
"archived": false,
"claimNumber": "555666777",
"dateOfLoss": "2024-06-01T16:00:00.000Z",
"brand": "Lovable Insurance"
},
"state": "open",
"caseType": "claim",
"customer": {
"id": "69226ab8-db02-4b67-b1b7-7eaf1ff2d5f5",
"first": "Test",
"last": "Events",
"email": "",
"mobile": "+15552093482",
"role": "enduser",
"optStatus": true,
"optStatusDetail": "OPTED_IN"
},
"primaryContact": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createdBy": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createTime": "2024-06-05T14:34:56.656Z",
"creationSource": "WebApp",
"referenceId": "555666777",
"privacy": "public",
"marleyNumber": "+17627951807",
"languagePreference": "en",
"secondaryOperators": [
{
"id": "a3a278ec-0ff1-46b3-80ce-a3abf96358f2",
"first": "Steven",
"last": "Colon",
"email": "steven.colon@himarley.com",
"role": "operator"
}
],
"isTotalLoss": true,
"releaseIssues": [
{
"id": "12345",
"status": "COMPLETE",
"code": "VRRLR",
"description": "Verbal Release Required",
"comment": "comment",
"resolved": false,
"timestamp": "2024-06-05T14:42:59.000Z"
}
],
"totalLossData": {
"stockNumber": "123456789",
"sellerCode": "TestSellerCode",
"companyCode": "PLY",
"vehicleLocation": {
"addressLine1": "1234 ADDRESS RD",
"addressLine2": "",
"city": "CITY",
"zipCode": "11111",
"companyName": "COMPANY NAME",
"contactPhone": "8885552222",
"type": "Shop"
},
"vehicleDetails": {
"make": "MAKE",
"model": "MODEL",
"color": "COLOR",
"year": 1999,
"licensePlateNumber": ""
},
"ownerDetails": {
"firstName": "Test",
"lastName": "Events",
"phoneNumber": "5552093482"
}
},
"event": {
"type": "total_loss.release_issue.completed",
"body": "Release Issue Completed",
"eventTime": "2024-06-05T14:55:59Z",
"details": {
"id": "12345",
"code": "VRRLR",
"description": "Verbal Release Required",
"timestamp": "2024-06-05T14:42:59.000Z"
}
}
}
total_loss.release_issue.updated
{
"caseData": {
"id": "f02642d0-34cb-4800-b123-b581a789648f",
"archived": false,
"claimNumber": "555666777",
"dateOfLoss": "2024-06-01T16:00:00.000Z",
"brand": "Lovable Insurance"
},
"state": "open",
"caseType": "claim",
"customer": {
"id": "69226ab8-db02-4b67-b1b7-7eaf1ff2d5f5",
"first": "Test",
"last": "Events",
"email": "",
"mobile": "+15552093482",
"role": "enduser",
"optStatus": true,
"optStatusDetail": "OPTED_IN"
},
"primaryContact": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createdBy": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createTime": "2024-06-05T14:34:56.656Z",
"creationSource": "WebApp",
"referenceId": "555666777",
"privacy": "public",
"marleyNumber": "+17627951807",
"languagePreference": "en",
"secondaryOperators": [
{
"id": "a3a278ec-0ff1-46b3-80ce-a3abf96358f2",
"first": "Steven",
"last": "Colon",
"email": "steven.colon@himarley.com",
"role": "operator"
}
],
"isTotalLoss": true,
"releaseIssues": [
{
"id": "12345",
"status": "COMPLETE",
"code": "VRRLR",
"description": "Verbal Release Required",
"comment": "comment",
"resolved": false,
"timestamp": "2024-06-05T14:42:59.000Z"
}
],
"totalLossData": {
"stockNumber": "123456789",
"sellerCode": "TestSellerCode",
"companyCode": "PLY",
"vehicleLocation": {
"addressLine1": "1234 ADDRESS RD",
"addressLine2": "",
"city": "CITY",
"zipCode": "11111",
"companyName": "COMPANY NAME",
"contactPhone": "8885552222",
"type": "Shop"
},
"vehicleDetails": {
"make": "MAKE",
"model": "MODEL",
"color": "COLOR",
"year": 1999,
"licensePlateNumber": ""
},
"ownerDetails": {
"firstName": "Test",
"lastName": "Events",
"phoneNumber": "5552093482"
}
},
"event": {
"type": "total_loss.release_issue.completed",
"body": "Release Issue Completed",
"eventTime": "2024-06-05T14:55:59Z",
"details": {
"id": "12345",
"code": "VRRLR",
"description": "Verbal Release Required",
"timestamp": "2024-06-05T14:42:59.000Z"
}
}
}
total_loss.release_issue.resolved
{
"caseData": {
"id": "f02642d0-34cb-4800-b123-b581a789648f",
"archived": false,
"claimNumber": "555666777",
"dateOfLoss": "2024-06-01T16:00:00.000Z",
"brand": "Lovable Insurance"
},
"state": "open",
"caseType": "claim",
"customer": {
"id": "69226ab8-db02-4b67-b1b7-7eaf1ff2d5f5",
"first": "Test",
"last": "Events",
"email": "",
"mobile": "+15552093482",
"role": "enduser",
"optStatus": true,
"optStatusDetail": "OPTED_IN"
},
"primaryContact": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createdBy": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createTime": "2024-06-05T14:34:56.656Z",
"creationSource": "WebApp",
"referenceId": "555666777",
"privacy": "public",
"marleyNumber": "+17627951807",
"languagePreference": "en",
"secondaryOperators": [
{
"id": "a3a278ec-0ff1-46b3-80ce-a3abf96358f2",
"first": "Steven",
"last": "Colon",
"email": "steven.colon@himarley.com",
"role": "operator"
}
],
"isTotalLoss": true,
"releaseIssues": [
{
"id": "12345",
"status": "RESOLVED",
"code": "VRRLR",
"description": "Verbal Release Required",
"comment": "comment",
"resolved": true,
"timestamp": "2024-06-05T14:42:59.000Z"
}
],
"totalLossData": {
"stockNumber": "123456789",
"sellerCode": "TestSellerCode",
"companyCode": "PLY",
"vehicleLocation": {
"addressLine1": "1234 ADDRESS RD",
"addressLine2": "",
"city": "CITY",
"zipCode": "11111",
"companyName": "COMPANY NAME",
"contactPhone": "8885552222",
"type": "Shop"
},
"vehicleDetails": {
"make": "MAKE",
"model": "MODEL",
"color": "COLOR",
"year": 1999,
"licensePlateNumber": ""
},
"ownerDetails": {
"firstName": "Test",
"lastName": "Events",
"phoneNumber": "5552093482"
}
},
"event": {
"type": "total_loss.release_issue.resolved",
"body": "Release Issue Resolved",
"eventTime": "2024-06-05T14:45:33Z",
"details": {
"id": "12345",
"code": "VRRLR",
"description": "Verbal Release Required",
"timestamp": "2024-06-05T14:42:59.000Z"
}
}
}
total_loss.release_issue.resolved
{
"caseData": {
"id": "f02642d0-34cb-4800-b123-b581a789648f",
"archived": false,
"claimNumber": "555666777",
"dateOfLoss": "2024-06-01T16:00:00.000Z",
"brand": "Lovable Insurance"
},
"state": "open",
"caseType": "claim",
"customer": {
"id": "69226ab8-db02-4b67-b1b7-7eaf1ff2d5f5",
"first": "Test",
"last": "Events",
"email": "",
"mobile": "+15552093482",
"role": "enduser",
"optStatus": true,
"optStatusDetail": "OPTED_IN"
},
"primaryContact": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createdBy": {
"id": "e3b0a637-601b-442d-aa9d-9226e58020f5",
"first": "Ian",
"last": "Swain",
"email": "ian.swain@himarley.com",
"role": "operator"
},
"createTime": "2024-06-05T14:34:56.656Z",
"creationSource": "WebApp",
"referenceId": "555666777",
"privacy": "public",
"marleyNumber": "+17627951807",
"languagePreference": "en",
"secondaryOperators": [
{
"id": "a3a278ec-0ff1-46b3-80ce-a3abf96358f2",
"first": "Steven",
"last": "Colon",
"email": "steven.colon@himarley.com",
"role": "operator"
}
],
"isTotalLoss": true,
"releaseIssues": [],
"totalLossData": {
"stockNumber": "123456789",
"sellerCode": "TestSellerCode",
"companyCode": "PLY",
"vehicleLocation": {
"addressLine1": "1234 ADDRESS RD",
"addressLine2": "",
"city": "CITY",
"zipCode": "11111",
"companyName": "COMPANY NAME",
"contactPhone": "8885552222",
"type": "Shop"
},
"vehicleDetails": {
"make": "MAKE",
"model": "MODEL",
"color": "COLOR",
"year": 1999,
"licensePlateNumber": ""
},
"ownerDetails": {
"firstName": "Test",
"lastName": "Events",
"phoneNumber": "5552093482"
}
},
"event": {
"type": "title_express.request_created",
"body": "Title Express Request Created",
"eventTime": "2023-06-14T19:09:56.000Z"
}
}
survey.initiated
{
"caseData": {
"brand": "Hi Marley",
"claimNumber": "12123515",
"dateOfLoss": "2021-07-23T16:00:00.000Z",
"id": "5164e03e-22dd-4a95-b79e-81d04e48b0a3",
"archived": false
},
"state": "open",
"caseType": "claim",
"customer": {
"id": "a5d6206b-7b58-4b09-823f-35516b199821",
"first": "Smith",
"last": "John",
"email": "customer8013@testemail.com",
"mobile": "+555555555",
"role": "enduser",
"optStatus": true,
"optStatusDetail": "OPTED_IN"
},
"primaryContact": {
"id": "20764b4a-0fe4-4bae-a100-40276b2d4d45",
"first": "Carrier",
"last": "Adjuster",
"email": "carrier.adjuster@carrier.org",
"role": "operator"
},
"createTime": "2021-07-30T19:38:51.744Z",
"referenceId": "12123515",
"privacy": "public",
"marleyNumber": "+17252279925",
"languagePreference": "en",
"secondaryOperators": [],
"event": {
"type": "survey.initiated",
"body": "Survey Workflow Initiated",
"eventTime": "2024-06-05T14:46:38Z"
}
}
survey.exited
{
"caseData": {
"brand": "Hi Marley",
"claimNumber": "12123515",
"dateOfLoss": "2021-07-23T16:00:00.000Z",
"id": "5164e03e-22dd-4a95-b79e-81d04e48b0a3",
"archived": false
},
"state": "open",
"caseType": "claim",
"customer": {
"id": "a5d6206b-7b58-4b09-823f-35516b199821",
"first": "Smith",
"last": "John",
"email": "customer8013@testemail.com",
"mobile": "+555555555",
"role": "enduser",
"optStatus": true,
"optStatusDetail": "OPTED_IN"
},
"primaryContact": {
"id": "20764b4a-0fe4-4bae-a100-40276b2d4d45",
"first": "Carrier",
"last": "Adjuster",
"email": "carrier.adjuster@carrier.org",
"role": "operator"
},
"createTime": "2021-07-30T19:38:51.744Z",
"referenceId": "12123515",
"privacy": "public",
"marleyNumber": "+17252279925",
"languagePreference": "en",
"secondaryOperators": [],
"event": {
"type": "survey.exited",
"body": "Survey Workflow Exited",
"eventTime": "2024-06-05T14:46:38Z"
}
}
survey.complete
{
"caseData": {
"brand": "Hi Marley",
"claimNumber": "12123515",
"dateOfLoss": "2021-07-23T16:00:00.000Z",
"id": "5164e03e-22dd-4a95-b79e-81d04e48b0a3",
"archived": false
},
"state": "open",
"caseType": "claim",
"customer": {
"id": "a5d6206b-7b58-4b09-823f-35516b199821",
"first": "Smith",
"last": "John",
"email": "customer8013@testemail.com",
"mobile": "+555555555",
"role": "enduser",
"optStatus": true,
"optStatusDetail": "OPTED_IN"
},
"primaryContact": {
"id": "20764b4a-0fe4-4bae-a100-40276b2d4d45",
"first": "Carrier",
"last": "Adjuster",
"email": "carrier.adjuster@carrier.org",
"role": "operator"
},
"createTime": "2021-07-30T19:38:51.744Z",
"referenceId": "12123515",
"privacy": "public",
"marleyNumber": "+17252279925",
"languagePreference": "en",
"secondaryOperators": [],
"event": {
"type": "survey.complete",
"body": "Survey Workflow Complete",
"eventTime": "2024-06-05T14:46:38Z"
}
}
Comments
0 comments
Please sign in to leave a comment.