๐Ÿ“˜

Coming Soon: More webhook events

More webhook events for read and archival status among others are coming soon.

When implementing webhook support in your application, you should ensure you are using the event property to correctly route and handle 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"
      }
    ]
  }
}
PropertyDescription
inboxAppIdYour Inbox App ID.
externalConversationIdThe unique identifier for the conversation.
bodyThe user's message.
messageIdThe FUB ID of the reply. This can be used for updating delivery statuses.
userDataThe FUB user that sent the message.
attachmentsAn array of attachments the user is sending.
userData PropertyDescription
idThe ID of the user that sent the message.
attachments PropertyDescription
filenameThe name of the file, for display purposes.
urlThe URL where the file can be retrieved.
mimeTypeThe MIME type of the file.