Webhooks

Follow Up Boss sends a webhook to the Subscription URL you provided when installing your app when certain activity happens in an Inbox App conversation within Follow Up Boss.

`inboxAppReply`

Sent when a user replies to an Inbox App conversation from Follow Up Boss.

{
  "eventId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "eventCreated": "2024-01-01T12:00:00+00:00",
  "event": "inboxAppReply",
  "data": {
    "inboxAppId": 1,
    "externalConversationId": "exampleExtConversationId",
    "body": "An example message.",
    "messageId": 1,
    "userData": {
      "id": 1
    },
    "attachments": [
      {
        "filename": "example.pdf",
        "url": "https://followupboss.test/example.pdf",
        "mimeType": "application/pdf"
      }
    ]
  }
}

Property	Description
`inboxAppId`	Your Inbox App ID.
`externalConversationId`	The unique identifier for the conversation.
`body`	The user's message.
`messageId`	The FUB ID of the reply. This can be used for updating delivery statuses.
`userData`	The FUB user that sent the message.
`attachments`	An array of attachments the user is sending.

`userData` Property	Description
`id`	The ID of the user that sent the message.

`attachments` Property	Description
`filename`	The name of the file, for display purposes.
`url`	The URL where the file can be retrieved.
`mimeType`	The MIME type of the file.

`inboxAppConversationRead`

Sent when a user reads an Inbox App conversation. Mirrors the unread gleam behavior in Follow Up Boss.

{
  "eventId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "eventCreated": "2024-01-01T12:00:00+00:00",
  "event": "inboxAppConversationRead",
  "data": {
    "externalConversationId": "exampleExtConversationId",
    "fubConversationId": 1,
    "inboxAppId": 1,
    "userId": 1
  }
}

Property	Description
`externalConversationId`	The unique identifier for the conversation.
`fubConversationId`	The FUB ID of the Inbox App conversation.
`inboxAppId`	Your Inbox App ID.
`userId`	The user that read the conversation.

`inboxAppConversationArchived`

Sent when a conversation is archived (closed.)

{
  "eventId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "eventCreated": "2024-01-01T12:00:00+00:00",
  "event": "inboxAppConversationArchived",
  "data": {
    "externalConversationId": "exampleExtConversationId",
    "fubConversationId": 1,
    "inboxAppId": 1
  }
}

Property	Description
`externalConversationId`	The unique identifier for the conversation.
`fubConversationId`	The FUB ID of the Inbox App conversation.
`inboxAppId`	Your Inbox App ID.

`inboxAppConversationUnarchived`

Sent when a conversation is unarchived (re-opened.)

{
  "eventId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "eventCreated": "2024-01-01T12:00:00+00:00",
  "event": "inboxAppConversationUnarchived",
  "data": {
    "externalConversationId": "exampleExtConversationId",
    "fubConversationId": 1,
    "inboxAppId": 1
  }
}

Property	Description
`externalConversationId`	The unique identifier for the conversation.
`fubConversationId`	The FUB ID of the Inbox App conversation.
`inboxAppId`	Your Inbox App ID.

`inboxAppConversationAssigned`

Sent when a conversation is assigned to another User or Shared Inbox.

{
  "eventId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "eventCreated": "2024-01-01T12:00:00+00:00",
  "event": "inboxAppConversationAssigned",
  "data": {
    "externalConversationId": "exampleExtConversationId",
    "fubConversationId": 1,
    "inboxAppId": 1,
    "assignedUserId": 0,
    "assignedSharedInboxId": 1
  }
}

Property	Description
`externalConversationId`	The unique identifier for the conversation.
`fubConversationId`	The FUB ID of the Inbox App conversation.
`inboxAppId`	Your Inbox App ID.
`assignedUserId`	User the conversation is assigned to, or `0` if not assigned to a user.
`assignedSharedInboxId`	Inbox the conversation is assigned to, or `0` if not assigned to an Inbox.

`inboxAppDeactivated`

Sent when an Inbox App is deactivated (uninstalled) from the Follow Up Boss integrations page.

{
  "eventId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "eventCreated": "2024-01-01T12:00:00+00:00",
  "event": "inboxAppDeactivated",
  "data": {
    "inboxAppId": 1
  }
}

Property	Description
`inboxAppId`	Your Inbox App ID.