<aside> <img src="/icons/info-alternate_red.svg" alt="/icons/info-alternate_red.svg" width="40px" /> CONFIDENTIALITY NOTE & DISCLAIMER

To Authorised Personnel Only

This document contains sensitive and confidential information intended solely for the use of authorised personnel. Unauthorised use, disclosure, or copying of this document or any part thereof is strictly prohibited and may be unlawful. If you are not the intended recipient, please notify us immediately at [email protected]

Disclaimer

This document may contain proprietary information, trade secrets, or privileged information. The confidentiality attached to this document remains unaltered, and any dissemination, distribution, or unauthorised copying of this document is strictly forbidden.

If you are not the intended recipient, please notify us immediately at [email protected]

</aside>

Document Details

Particulars Details
Version 1.0
Last update at February 13, 2025
Last updated by @Anonymous
Audience BotPenguin Tech Team & Tech team at Relevant 3rd Party Work flows Builder Apps
Purpose To enable the workflow builder apps to create the Integration with BotPenguin
Revision Requirement Once a Quarter

About

BotPenguin is a platform that offers AI-powered chatbot solutions for businesses. BotPenguin support following Trigger and actions as of now

Triggers

Triggers are being initiated by the end users on the BotPenguin Platform. Here are the supported triggers

  1. New contact created
  2. New incoming message

Actions

Actions are being performed when request is being received from any workflow builder mediator app. Here are the supported actions

  1. Add new contact
  2. Send session message
  3. Update the custom attributes of the contact

Key Terminologies

Term Description
Customer Customers are the BotPenguin customer having a valid active account on the BotPenguin.
Bots BotPenguin bots deployed on available channels for chat automation
API Token Unique API token for any customer to perform action on its behalf using BotPenguin APIs
Bot ID Unique Identifier of a bot
Contacts End user who is using the bot
Message Message send by the end user to bot or vice-versa
Mediator or Work flow Builder Apps Apps providing the service of the work flow builder based on the triggers and actions

Integration Flow

The following integration work flow will be followed to make the integrations .

Establishing Integration | Mediator App ↔ BotPenguin

High-level flow diagram as follows: