SMS events

Event

sms.message.added

Trigger

A new message was added to an SMS conversation.

Example of a `sms.message.added` event:

{
  "id": "9f0be54f-f536-482a-82cf-f476d0443184",
  "description": "A new SMS message was added (sent/received) to a conversation.",
  "type": "sms.message.added",
  "agentId": "ZPxEFRfTGb7QEnFW63zA",
  "version": "0",
  "createdAt": "2025-08-02T17:26:15.896Z",
  "data": {
    "object": {
      "id": "IM771ad8e30b0846529dda887eae98487a",
      "from": "+1415...",
      "to": "+1561...",
      "direction": "outbound",
      "conversationId": "CH74bd2a0639244639b084643defe24d0a",
      "customerId": "ySOkYW0cE63JublL9mAC",
      "body": "Hola Como estas busco a gicela ",
      "media": [],
      "createdAt": "2025-08-02T17:26:09.880Z",
      "createdBy": {
        "role": "user",
        "photoURL": "https://lh3.googleusercontent.com/a/ACg8ocLlHWFB3yM70Uul8UUSY_0iRO-bHduuhTVbEF192ESn=s96-c",
        "displayName": "S*** G***",
        "email": "s***@voxity.ai",
        "uid": "85lPIIpBlIeFONBNxIZhKibc5rq2"
      },
      "metadata": {
        "customerPhoneNumber": {
          "createdAt": "2025-07-16T21:26:31.113Z",
          "verified": true,
          "updatedAt": "2025-07-31T16:33:41.248Z",
          "phoneNumber": "+1561...",
          "type": "primary",
          "phoneType": "unknown",
          "id": "rHTUYd2LXDsvLGWkMBIV",
          "conversationSid": "CH74bd2a0639244639b084643defe24d0a",
          "capabilities": {
            "sms": {
              "send": true,
              "consent": {
                "status": "optedIn",
                "statusDate": null,
                "reason": null
              },
              "receive": true
            }
          }
        },
        "conversation": [
          {
            "id": "IM9c566a00f8444f01aba88cb81ff63777",
            "createdAt": "2025-07-16T21:30:22.000Z",
            "role": "user",
            "media": [],
            "body": "Hola le escribo desde SUnset calle 8 \n\nque servicio le interesa "
          },
          {
            "role": "user",
            "body": "Saludos, le recodamos que tiene un pago pendiente. Debe completar su pago antes de la proxima cita.",
            "media": [],
            "id": "IM2ec6469310c24a31a6a9d63a22156712",
            "createdAt": "2025-07-17T18:05:22.000Z"
          },
          {
            "media": [],
            "id": "IMfb6235adcb354f77844c5a99f4c0a817",
            "body": "Hi Sara, are you still interested in the smile design for your mom?",
            "role": "user",
            "createdAt": "2025-07-18T17:35:14.000Z"
          },
          {
            "id": "IM97596dc80f2f4d1ca5a9d0b2406177ed",
            "media": [],
            "role": "user",
            "body": "Hola como estas",
            "createdAt": "2025-07-31T17:17:54.000Z"
          },
          {
            "body": "Hola Como estas busco a gicela ",
            "createdAt": "2025-08-02T17:26:09.000Z",
            "role": "user",
            "id": "IM771ad8e30b0846529dda887eae98487a",
            "media": []
          }
        ]
      },
      "expanded": {
        "customer": {
          "id": "ySOkYW0cE63JublL9mAC",
          "channel": "facebook",
          "updatedAt": "2025-07-18T17:35:25.695Z",
          "createdAt": "2025-07-16T21:05:12.617Z",
          "tags": [],
          "lastName": "G***",
          "phoneNumber": "+1561...",
          "firstName": "S***"
        },
        "opportunities": [
          {
            "removed": false,
            "pipelineId": "URDzWNO4JlMHWJIPWygY",
            "score": 70,
            "id": "3D9rDuUC0sxkcRIDoNlT",
            "amount": null,
            "customerId": "ySOkYW0cE63JublL9mAC",
            "updatedAt": "2025-07-18T17:35:35.598Z",
            "tags": [],
            "name": "Smile Design Inquiry - S*** G***",
            "stageId": "9GymqnzjzaHxZYQkVFk8",
            "ownerId": null,
            "createdAt": "2025-07-16T21:05:41.307Z"
          }
        ]
      }
    }
  }
}