Sign in

v53

latestOpenAPI 3.1.1raw.githubusercontent.com2026-07-264065213.4 KB

The conversation.created event is delivered whenever a new conversation is started with a contact. This could be when either the contact sends a message to your Surge number or when you create a conversation, whether by sending an initial message to the contact or by manually creating the conversation using the API.

postWebhookconversationCreated

Payload

account_idstring required

The ID of the account in which this event occurred

timestampstring date-time required

The timestamp when this event occurred, in ISO8601 format

type'conversation.created' required

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

Example payload

{
  "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"
}

Response

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