Inbox
Docs

Schema

This page provides the complete schema for webhook payloads. Inbox is platform‑agnostic and the schema supports multiple social platforms. At present, we send webhooks for X (Twitter).

A note on IDs

Inbox stores two types of IDs for objects that relate to X:

  • id — The Inbox ID, which is the ID of the Inbox object
  • platformId — The original X 'platform' ID, which is the ID of the X user, conversation, etc.

Envelope

Metadata about the webhook.

Example

{
  "event": "targetContacted",
  "platform": "twitter",
  "timestamp": "2025-08-22T17:24:46.439Z",
  "version": "1.0",
}
PropTypeExample
event
string
targetContacted
version
string
1.0
timestamp
string (ISO 8601)
2025-08-17T18:30:00.000Z
platform
string
twitter
source
string
inbox

Team

The Inbox team/workspace that triggered the event.

Example

{
  "id": "lhw616llzg332bj2d4meoiob",
  "name": "Inbox",
  "slug": "inbox"
}
PropTypeExample
id
string
"pwxtytmwrw58mao0mvb4rwmn"
name
string
"Acme Agency"
slug
string
"acme-agency"

Message

The specific message sent or referenced by the event.

Example

{
  "id": "m428nyzi8wp4js8pg5oujg93",
  "platformId": "1958943422296768798",
  "platform": "twitter",
  "content": "Hey there Kevin!",
  "origin": "internal",
  "authorId": "grfwa7zqw4umiimqed0ln0wx",
  "userId": null,
  "teamId": "lhw616llzg332bj2d4meoiob",
  "threadId": "elkm6v25vey8rq34u9pktfju",
  "campaignId": "md1gcfz5sg7s0eh9hywoxdvi",
  "createdAt": "2025-08-22T17:24:42.019Z",
}
PropTypeExample
id
string
"p9gamzseat6m7fhvpubvgxwm"
platformId
string | null
"1628473912045676544"
platform
string
"twitter"
content
string
"Hey, I'm reaching out from Acme Agency..."
origin
"internal" | "external" | null
"internal"
authorId
string
"z7t2luwcjdgdje5e65rrhkpc"
userId
string | null
"user_123"
teamId
string
"pwxtytmwrw58mao0mvb4rwmn"
threadId
string
"dce5hiknakxdg3tc24kvw0o7"
campaignId
string | null
null
createdAt
string
"2025-08-17T18:30:00.000Z"

Thread

The conversation that the message belongs to.

Example

{
  "id": "elkm6v25vey8rq34u9pktfju",
  "platform": "twitter",
  "platformId": "1171040852623417351-1566123362161725440",
  "teamId": "lhw616llzg332bj2d4meoiob",
  "accountLinkId": "grfwa7zqw4umiimqed0ln0wx",
  "externalId": "f85dh7t4j1jvptlavp5du03f",
  "createdAt": "2025-08-03T21:33:57.000Z",
  "updatedAt": "2025-08-22T17:24:42.000Z",
  "lastMessageTimestamp": "2025-08-22T17:24:42.000Z",
  "interactionType": "mutual",
  "done": true,
}
PropTypeExample
id
string
"df6jbw4h36..."
platform
"twitter"
-
platformId
string
"1234567890"
teamId
string
-
accountLinkId
string
-
externalId
string
-
createdAt
string
-
updatedAt
string | null
-
lastMessageTimestamp
string | null
"2025-08-22T12:00:00.000Z"
interactionType
"contacted" | "mutual" | null
"mutual"
done
boolean
true

The linked account that the thread belongs to.

Example

{
  "id": "grfwa7zqw4umiimqed0ln0wx",
  "teamId": "lhw616llzg332bj2d4meoiob",
  "platform": "twitter",
  "platformId": "1171040852623417351",
  "name": "Kevin",
  "username": "KevinPicchi",
  "image": "https://pbs.twimg.com/profile_images/1952887466865668096/J9BkWyaH.jpg"
}
PropTypeExample
id
string
"pwxtytmwrw58mao0mvb4rwmn"
teamId
string
"pwxtytmwrw58mao0mvb4rwmn"
platform
string
"twitter"
platformId
string
"1234567890"
name
string
"Acme Agency"
username
string
"acme-agency"
image
string
"https://example.com/image.png"

Campaign

The campaign that initiated the outreach.

Example

{
  "id": "md1gcfz5sg7s0eh9hywoxdvi",
  "name": "Outreach NYC",
  "type": "sequence",
  "status": "active",
  "createdAt": "2025-08-22T15:16:40.088Z",
  "updatedAt": "2025-08-22T17:24:26.000Z",
  "completedAt": null,
  "lastStartedAt": "2025-08-22T15:17:53.088Z",
  "totalRuntime": 7380912,
  "targetsCount": 29381,
  "contactedCount": 41,
  "repliesCount": 2,
  "replyRate": 0.04878,
  "completionRate": 0.13955,
  "hourlyMessageRate": 20,
  "scheduleTimezone": "America/New_York"
}
PropTypeExample
id
string
"df6jbw4h36..."
name
string
"August Outreach"
type
"sequence"
"sequence"
status
"draft" | "active" | "paused" | "completed"
"active"
createdAt
string
"2025-08-17T18:30:00.000Z"
updatedAt
string | null
null
completedAt
string | null
null
lastStartedAt
string | null
-
totalRuntime
number
292019
targetsCount
number
19820
contactedCount
number
100
repliesCount
number
2
replyRate
number
0.09
completionRate
number
0.15
hourlyMessageRate
number
20
scheduleTimezone
string
"America/Los_Angeles"

External

The prospect/contact on the social platform

Example

{
  "id": "f85dh7t4j1jvptlavp5du03f",
  "platformId": "1566123362161725440",
  "platform": "twitter",
  "displayName": "Inbox",
  "username": "InboxApp_",
  "image": "https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg",
  "data": {
    "entities": {
      "url": {
        "urls": [
          {
            "url": "https://t.co/89RF8aqqg6",
            "indices": [0, 23],
            "display_url": "inboxapp.com",
            "expanded_url": "https://inboxapp.com"
          }
        ]
      },
      "description": { "urls": [] }
    },
    "location": "",
    "verified": false,
    "created_at": "Sat Sep 03 17:58:06 +0000 2022",
    "description": "Social Selling CRM Close deals faster, stay organized, and never miss an opportunity. Starting with X",
    "listed_count": 16,
    "friends_count": 287,
    "statuses_count": 813,
    "followers_count": 2304,
    "favourites_count": 2502,
    "profile_banner_url": "https://pbs.twimg.com/profile_banners/1566123362161725440/1753273968",
    "profile_image_url_https": "https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6_normal.jpg"
  }
}
PropTypeExample
id
string
"hzcai5t59nn9vsck3rbuepyg"
platformId
string
"1954360649393295360"
platform
string
"twitter"
displayName
string
"Inbox"
username
string
"InboxApp_"
image
string
"https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6_normal.jpg"
data
unknown
unknown

Learn more about externals:

External user

Learn more about Inbox's external user (prospect/contact) object

Webhooks

Configure webhooks to receive events from Inbox

External user

Schema for the external user (prospect/contact) object