The optOut webhook event is triggered whenever a lead opts out of receiving further messages from your Apten assistant. This can be used to update your CRM or other systems about the lead’s communication preferences.

​
Payload

{
  "event": "optOut",
  "data": {
    "leadId": "a7e92c5d-f301-4b89-ae16-8f35d02cx9z",
    "phone": "+13305551234",
    "isTwilioOptOut": true
  },
  "timestamp": "2024-02-18T09:45:22Z"
}

​
Properties

PropertyTypeDescription
eventstringThe webhook event type (optOut).
data.leadIdstringThe unique identifier for the lead who opted out.
data.phonestringThe phone number of the lead who opted out.
data.isTwilioOptOutbooleanIndicates whether the opt-out was processed through Twilio.
timestampstringThe ISO 8601 timestamp when the opt-out occurred.