conversation.created

{
  "account_id": "acct_01japd271aeatb7txrzr2xj8sg",
  "data": {
    "contact": {
      "first_name": "Dominic",
      "id": "ctc_01ja88cboqffhswjx8zbak3ykk",
      "last_name": "Toretto",
      "phone_number": "+18015551234"
    },
    "id": "cnv_01jav8xy7fe4nsay3c9deqxge9",
    "phone_number": {
      "campaign_id": null,
      "id": "pn_01jsjwe4d9fx3tpymgtg958d9w",
      "name": "(801) 555-6789",
      "number": "+18015556789",
      "type": "local"
    }
  },
  "timestamp": "2024-10-21T23:29:41Z",
  "type": "conversation.created"
}

WEBHOOK

conversationCreated

{
  "account_id": "acct_01japd271aeatb7txrzr2xj8sg",
  "data": {
    "contact": {
      "first_name": "Dominic",
      "id": "ctc_01ja88cboqffhswjx8zbak3ykk",
      "last_name": "Toretto",
      "phone_number": "+18015551234"
    },
    "id": "cnv_01jav8xy7fe4nsay3c9deqxge9",
    "phone_number": {
      "campaign_id": null,
      "id": "pn_01jsjwe4d9fx3tpymgtg958d9w",
      "name": "(801) 555-6789",
      "number": "+18015556789",
      "type": "local"
    }
  },
  "timestamp": "2024-10-21T23:29:41Z",
  "type": "conversation.created"
}

Fires when a new conversation is created. A conversation is the thread that ties all messages between a specific phone number and a specific contact. Surge creates a new conversation the first time a contact messages one of your numbers (or the first time you message a new contact). When a contact sends their first message, both conversation.created and message.received fire. Subsequent messages on the same thread fire only message.received.

Common use case

Use conversation.created to create a support ticket, add a lead to your CRM, or notify your team when a new contact reaches out for the first time.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

account_id

string

required

The ID of the account in which this event occurred

data

object

required

The data associated with the event

Show child attributes

timestamp

string<date-time>

required

The timestamp when this event occurred, in ISO8601 format

type

string

required

The type of the event. Always conversation.created for this event.

Allowed value: "conversation.created"

Response

200

Return a 200 status to indicate that the data was received successfully

⌘I

Getting started

Endpoints

Webhooks

conversation.created

Common use case

Authorizations

Body

Response

​Common use case

Authorizations

Body

Response

Common use case