Embedding the BotPenguin Inbox in 3rd Party Apps

This page contains information on how you can embed BotPenguin Inbox in any custom 3rd party application as IFrame.

Embedding the BotPenguin Inbox in 3rd Party Apps

This documentation provides instructions on how to embed the BotPenguin Inbox into any custom 3rd party application using an IFrame.

Prerequisite

Before embedding the BotPenguin Inbox, ensure the following prerequisites are met:

1. Approval: Obtain approval from the BotPenguin team for the intended use case.

2. Whitelisting: The parent URL under which the BotPenguin Inbox URL will be hosted must be whitelisted. Contact the BotPenguin support team to whitelist the Parent URL by sending an email with the details.

3. Make sure you have a valid and ready-to-use Customer Account to test the integration.

Implementation Steps

Follow these steps to embed the BotPenguin Inbox into your custom application:

1. The interface of authenticating and mapping BotPenguin and 3rd Party Application Users

   1. Create and Interface where customer can enter their API Token. Save that API token, It will be used in the subsequent calls. Customers can find their access token from the "Developers" section.

   2. Map the team members of the customer's account using the following API

      Get Team Members (Custom Users) -Use this API to list down all the team members under one customer account. Get Custom User (Team Member) Token - Use this API to get the team member's token and save the same for future use.

   3. Once the mapping is done, Save the same and use the team member's token in subsequent calls

2. Create Parent URL: Create a parent URL within your custom application where you plan to host the BotPenguin Inbox URL. Ensure that the BotPenguin team has confirmed the whitelisting of this URL.

3. Create IFrame: Set up an IFrame within your application where you want to display the BotPenguin Inbox.

4. Authenticate and Redirect User: Internally authenticate the user (Team member) and redirect them to the BotPenguin Inbox page. Use the following steps:

   • Authenticate the user by passing the following URL:

     https://app.botpenguin.com/api-login?token=********

     Replace ******** with the authentication token of the team member.

   • Upon successful authentication, internally redirect the user to the following URL:

     https://app.botpenguin.com/inbox-merged/chats?s=0

     This URL will open the BotPenguin Inbox.

By following these steps, you can seamlessly integrate the BotPenguin Inbox into your custom 3rd party application. If you encounter any issues or require assistance, please contact the BotPenguin support team.

❓ Got any questions?

If you have any questions, you can look into our repository of FAQs, most likely, you will find your answer here, If not, write us at [email protected].