Skip to main content

Webhook: Text Opt-out

URL path: /text-optout/ After a user has replied "STOP" to a text message, a text opt-out webhook is sent. The system looks up the record associated with the phone number that opted out and returns i…

NCOL Support
Updated by NCOL Support

URL path: /text-optout/

After a user has replied "STOP" to a text message, a text opt-out webhook is sent. The system looks up the record associated with the phone number that opted out and returns information about the phone number's workflow. The webhook uses Authorization Header and Authorization Token values for authentication to protect your data. Please contact 2X to configure these.

The object sent by the webhook uses the following structure:

{
	"agent_key": "ABC123",
	"record_phone_number": "7897897899",
	"record_first_name": "David",
	"record_last_name": "Smith",
	"record_zip_code": "98765",
	"record_timezone": "UTC-8",
	"meta": {
		"crm_id": "123"
	},
	"workflow_key": "DEF456",
	"workflow_day": 1,
	"workflow_call": 1,
	"workflow_end": false
}

Field Explanations

  • agent_key: The unique key for the most recent agent used with this phone number.
  • record_phone_number, record_zip_code, record_first_name, record_last_name, record_timezone, meta: The record information associated with the phone number that opted out.
  • workflow_key: The unique key used to identify the workflow that the record is in.
  • workflow_day: The current day number of the workflow schedule of the record.
  • workflow_call: The current call number (of the day, eg: Day 3, Call 1) of the workflow schedule of the record.
  • workflow_end: This field is included when the record has no additional steps defined in the 2X workflow table. It signifies the termination of the current workflow process.

How did we do?

Webhook: Inbound Text

Contact