External user

The external user represents the prospect/contact profile on the social platform. Today this is only X. The data field contains the platform's raw profile payload for advanced use cases.

Prop	Type	Example
`id`	`string`	`hzcai5t59nn9vsck3rbuepyg`
`platformId`	`string`	`1954360649393295360`
`platform`	`string`	`twitter`
`displayName`	`string`	`Inbox`
`username`	`string`	`InboxApp_`
`image`	`string (URL)`	`https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6_normal.jpg`
`data`	`object`	-

Overview

The external user represents the prospect/contact on the social platform. In webhook payloads, it appears under data.external

Inbox is platform-agnostic and the external user shape is consistent across platforms, except for the data field. For the complete Twitter user object, see the official docs: Twitter API User Object

Top-level fields

{
  "id": "hzcai5t59nn9vsck3rbuepyg",
  "platformId": "1954360649393295360",
  "platform": "twitter",
  "displayName": "Inbox",
  "username": "InboxApp_",
  "image": "https://pbs.twimg.com/profile_images/.../normal.jpg"
}

Prop	Type	Example
`id`	`string`	-
`platformId`	`string`	-
`platform`	`string`	-
`displayName`	`string`	-
`username`	`string`	-
`image`	`string (URL)`	-

Profile 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 ...",
  "listed_count": 16,
  "friends_count": 287,
  "statuses_count": 813,
  "followers_count": 2304,
  "favourites_count": 2502,
  "profile_banner_url": "https://.../banner.jpg",
  "profile_image_url_https": "https://.../normal.jpg"
}

Prop	Type	Example
`entities`	`object`	-
`location`	`string`	-
`verified`	`boolean`	-
`created_at`	`string`	-
`description`	`string`	-
`listed_count`	`number`	-
`friends_count`	`number`	-
`statuses_count`	`number`	-
`followers_count`	`number`	-
`favourites_count`	`number`	-
`profile_banner_url`	`string (URL)`	-
`profile_image_url_https`	`string (URL)`	-

Entities

Detailed breakdown of nested entities fields from the profile payload.

URL entities

{
  "url": {
    "urls": [
      {
        "url": "https://t.co/89RF8aqqg6",
        "indices": [0, 23],
        "display_url": "inboxapp.com",
        "expanded_url": "https://inboxapp.com"
      }
    ]
  }
}

Prop	Type	Example
`url`	`object`	-
`urls`	`array`	-

URL entry (urls[] item)

Prop	Type	Example
`url`	`string (URL)`	-
`indices`	`number[]`	-
`display_url`	`string`	-
`expanded_url`	`string (URL)`	-

Description entities

{
  "description": { "urls": [] }
}

Prop	Type	Example
`description`	`object`	-
`urls`	`array`	-