Webhook: Text Opt-in

URL path: /text-optin/

This webhook is sent if a lead texts "START" to opt back in to text messages.

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": "9876543210",
    "record_first_name": "John",
    "record_last_name": "Doe",
    "record_zip_code": "55555",
    "record_timezone": "UTC-7",
    "meta": { "lead_id": "123" },
    "workflow_key": "AABBCC",
    "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.
• 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.