Skip to main content

Webhook: CRM Send Text

URL path: /send-text/ If you have an existing, in-house texting system set up, you can use this webhook to get the message, phone number and other details for texts that need to be sent out. Currentl…

NCOL Support
Updated by NCOL Support

URL path: /send-text/

If you have an existing, in-house texting system set up, you can use this webhook to get the message, phone number and other details for texts that need to be sent out. Currently there are two types of texts that the system will send the webhook for: pre-call texts (sent several minutes before calling) and texts that should be left along with a voicemail. You can use the type key to distinguish between the two. For pre-call texts, the timing is important, so please send the text immediately when receiving the webhook.

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:

{
    "id": 1234,
    "agent_key": "ABC123",
    "record_phone_number": "...",
    "record_first_name": "John",
    "record_last_name": "Smith",
    "record_zip_code": "98765",
    "record_timezone": "UTC-8",
    "meta": { "lead_id": "123", "test_id": "abc" },
    "workflow_key": "DEF456",
    "workflow_day": 1,
    "workflow_call": 1,
    "workflow_end": false,
    "type": "pre-call",
    "message": "We will call you in several minutes, looking forward to talking with you."
}

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.
  • type: This can be pre-call or post-voicemail.
  • message: The message text to send to the record.

How did we do?

Webhook: Text Opt-out

Contact