Event ID 28: Opt-Out

Description

Whenever an end-user opts out of texting with Hi Marley, this webhook will post Case data to a designated HTTP Address so that carriers can store this data in their system of record (or any external system).

Registering Webhook

Use the following payload to subscribe to this webhook using the POST /webhooks/register endpoint

Request Payload

Note: The Headers array is a optional set of values that can be used to attach specific static headers to each webhook response for any purpose (e.g indicating the type of event, carrier authentication of payload with a token)

  {
    "EVENT_ID": 28,
    "HTTP_POST_ADDRESS": "http://mywebaddress.com/himarley/OptIn",
    "HEADERS": {
        "headerName1": "headerValue1",
        "headerName2": "headerValue2",
    }
  }

POST Payload Example

Opt-Out

{
   "caseData": {
     "id": "994cd384-9f96-459d-9f1d-c29ea1312541",
     "archived": false,
     "claimNumber": "mddl-rth-3rd",
     "dateOfLoss": "2023-04-11T08:33:39.048Z",
     "policyNumber": "gndr-mns-trth-2",
     "brand": "Lovable Insurance"
  },
   "businessName": "Insurance Company",
   "state": "open",
   "caseType": "claim",
   "customer": {
     "id": "392f64ee-6d9d-42c6-85eb-4ee4262c27e0",
     "first": "Samuel",
     "last": "Webb",
     "email": "[e-mail]",
     "mobile": "[phone]",
     "role": "enduser",
     "optStatus": true,
     "optStatusDetail": "OPTED_OUT"
   },
   "primaryContact": {
     "id": "5bea662f-2026-4bfa-be39-57a9ae6b083f",
     "first": "Jeremie",
     "last": "Quinones",
     "email": "[e-mail]",
     "mobile": "",
     "role": "operator"
   },
   "prevPrimaryContact": {
     "id": "643bb2f8-f82d-4e71-94f0-fad78172024a",
     "first": "Kevin",
     "last": "Roller",
     "email": "[e-mail]",
     "mobile": "",
     "role": "operator"
   },
 "createTime": "2023-04-04T18:40:46.626Z",
 "creationSource": "PublicApi",
 "referenceId": "mddl-rth-3rd",
 "privacy": "private-redacted",
 "marleyNumber": "[phone]",
 "languagePreference": "en",
 "secondaryOperators": []
 }