Skip to main content

Webhook: Inbound Text Response

URL path: /text-response/ If a lead sends a text to the system and the system automatically replies, the /text-reply/ webhook is sent. The webhook uses Authorization Header and Authorization Token va…

NCOL Support
Updated by NCOL Support

URL path: /text-response/

If a lead sends a text to the system and the system automatically replies, the /text-reply/ webhook is sent.

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": "5F7EDA",
    "record_phone_number": "9876543210",
    "record_first_name": "Peter",
    "record_last_name": null,
    "record_zip_code": "98101",
    "record_timezone": "UTC-7",
    "meta": { "lead_id": "123" },
    "workflow_key": "EEC663",
    "workflow_day": 1,
    "workflow_call": 1,
    "workflow_end": true,
    "message": "I want to know about pricing",
    "response": "Great question! A member of our team will follow up with pricing details soon."
}

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.
  • message: The message text the lead sent.
  • response: The message the system sent to the lead.

How did we do?

Webhook: Inbound Text Classification

Webhook: Text Opt-out

Contact