Skip to main content
{
  "id": "ck9v2m5nj0xp4wq7ybftrae8",
  "seq": 51,
  "teamId": "hzcai5t59nn9vsck3rbuepyg",
  "type": "message.created",
  "timestamp": "2025-01-15T14:30:00.000Z",
  "version": "1.0",
  "data": {
    "message": {
      "id": "p8rvk2m5j0xn4wq7ybftcael",
      "platform": "twitter",
      "platformId": "1876543210987654322",
      "threadId": "l44e15irdq4db30i77cgphhx",
      "teamId": "hzcai5t59nn9vsck3rbuepyg",
      "authorId": "1876543210987654321",
      "userId": null,
      "campaignId": null,
      "content": "Hey! I saw your post about the new API. Would love to chat about integrating it with our platform.",
      "origin": "external",
      "createdAt": "2025-01-15T14:30:00.000Z",
      "updatedAt": null,
      "isEdited": false,
      "isEncrypted": false,
      "entities": null,
      "attachment": null,
      "reactions": [],
      "replyData": null,
      "forwardData": null,
      "deletedAt": null,
      "platformDeletedAt": null
    },
    "thread": {
      "id": "l44e15irdq4db30i77cgphhx",
      "platform": "twitter",
      "platformId": "1566123362161725440:1876543210987654321",
      "done": false,
      "assigneeId": "r3km7xj9wq5p2bvnhfdteoly",
      "lastMessageTimestamp": "2025-01-15T14:30:00.000Z",
      "computedSortTimestamp": "2025-01-15T14:30:00.000Z",
      "createdAt": "2025-01-10T09:00:00.000Z",
      "status": "active",
      "variant": "xChat",
      "accountLinkId": "df6jbw4h36qm5d9iu2sgn7kx",
      "isSyncing": false,
      "isRequest": false,
      "typingIndicatorsEnabled": true,
      "lastMessage": {
        "id": "p8rvk2m5j0xn4wq7ybftcael",
        "content": "Hey! I saw your post about the new API. Would love to chat about integrating it with our platform.",
        "authorId": "1876543210987654321",
        "createdAt": "2025-01-15T14:30:00.000Z",
        "userId": null,
        "campaignId": null
      },
      "prospect": {
        "platform": "twitter",
        "platformId": "1876543210987654321",
        "externalId": "n7kxqm5d9iu2sgdf6jbw4h36",
        "displayName": "Sarah Chen",
        "username": "sarahchen",
        "handle": "@sarahchen",
        "image": "https://pbs.twimg.com/profile_images/example/photo.jpg",
        "context": {
          "tags": ["l44e15irdq4db30i77cgphhx"],
          "statusId": "x9wq5p2bvnhfdteolyr3km7j",
          "valuation": 2500,
          "notes": "Interested in enterprise plan"
        }
      }
    }
  }
}

When it fires

  • A prospect sends a DM to one of your connected accounts
  • A team member sends a message through the Inbox UI
  • A message is sent via the API
  • A campaign sends a message to a target
Check the origin field to distinguish the source: external (from the platform), internal (from the Inbox UI), or api (from the API). Campaign messages include a campaignId.

Payload

message
Message
required
The message object.
thread
Thread
required
The thread associated with this event.