Overview
The Control Yellow.ai action lets a mobile app open or close the Yellow.ai assistant from an app event. Yellow.ai is configured under Application builder → Settings → Apps & Integrations → Yellow.ai and is available for mobile apps.
Yellow.ai is available only in Mobile apps (iOS and Android). On a phone, the chatbot opens as a full-screen chat; closing it returns the user to the screen they were on. The action isn't offered in web apps. When a mobile app runs in a browser, such as the builder preview, Open chatbot opens nothing and shows "The Yellow.ai chatbot is only available in the mobile app."
Prerequisites
A Mobile app.
The Yellow.ai integration enabled with a Bot ID in Application builder → Settings → Apps & Integrations → Yellow.ai. The Control Yellow.ai action appears in the action picker only after you enable the integration.
A device build of your app to test on. The chatbot doesn't open in the builder preview.
Set Up the Integration
In your mobile app, open Application builder → Settings → Apps & Integrations → Yellow.ai.
Turn on Enable Yellow.ai.
Enter your Bot ID — the bot's unique ID from your Yellow.ai dashboard. It decides which bot loads. This field is required.
Optionally, set Bot name (overrides the title in the chat header; leave blank to use the name set on Yellow.ai) and Bot icon (the avatar shown next to the bot's messages — SVG, PNG, JPEG or WEBP).
Optionally, add User context fields. Each field is a name and a value that's sent to the bot when it launches, so its replies can be personalized. Values support data pills, such as the user's name or employee code.
Your settings save automatically. Publish your app so users get the change. For widget styling, follow the panel's Customization docs link.
Parameters
Field | Required | Description |
|---|---|---|
Operation | Yes | Open chatbot ( |
User token | No | Shown only for Open chatbot. Identifies the user to Yellow.ai for their own chat session. Supports bindings. If you leave it blank, the chat opens anonymously. To tie the chat to a user, bind User token, for example to {{ userContext['id'] }} or a token from your backend. |
The Bot ID, bot name, bot icon and user context always come from the integration settings — you don't set them on the action.
Step-by-Step Usage Guide
Enable the integration: Complete the setup above and publish the app.
Add a help entry point: On any page where users might need help, add a button or link, such as "Chat with us".
Open the chatbot: In its On Click event, add the Control Yellow.ai action and choose Open chatbot. Optionally, set User token.
Close it from your app (optional): Use the Control Yellow.ai action with Close chatbot wherever you need to dismiss the chat from your app, for example after a flow finishes. Closing a chat that isn't open does nothing, so it's safe to fire.
Test on a device: Install a build of your app on a phone, tap your button, and check that the bot opens with your bot name, icon and user context.
Examples
Open the chatbot
{ "actionType": "controlYellowAI", "payload": { "operation": "open" } }
Open the chatbot with a token your backend issued
{ "actionType": "controlYellowAI", "payload": { "operation": "open", "userToken": "{{ getChatToken['data']['token'] }}" } }
Use this only when Yellow.ai expects a token from your own backend. If you leave User token blank, the chat opens anonymously.
Close the chatbot
{ "actionType": "controlYellowAI", "payload": { "operation": "close" } }