NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Botbaba connects to a Nagent workspace with an API key. Once it is connected, agents can call 42 Botbaba actions, such as "Get Bot Widget Settings", "Get Broadcast" and "Get BotBaba Contact". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Botbaba, with input parameters and output schema.
BOTBABA_CART_CREATION_EVENT_SIMULATORTool to simulate a Shopify cart creation webhook payload. Use when generating test payloads for BOTBABA_CART_CREATION_SHOPIFY_WEBHOOK.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_CART_CREATION_SHOPIFY_WEBHOOKTool to receive Shopify Cart Creation webhooks. Use when configuring Shopify webhook for Cart Creation events and forwarding the payload to Botbaba. Must be called upon receiving Shopify payload.
Input parameters
Full JSON payload sent by Shopify for Cart Creation event
Webhook topic
Webhook delivery ID
API version
HMAC-SHA256 signature
Shop domain
Trigger timestamp
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_CART_UPDATE_SHOPIFY_WEBHOOKTool to forward Shopify cart update events to BotBaba. Use when processing Shopify Cart Update webhook after configuring the webhook in your store.
Input parameters
Full JSON object received from Shopify when a cart is updated
Webhook topic, typically 'carts/update'
Webhook delivery ID
API version
HMAC-SHA256 signature
Shop domain
Trigger timestamp (ISO 8601)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_CHECKOUT_CREATION_SHOPIFY_WEBHOOKTool to receive Shopify checkout creation webhook events. Use when configuring your Shopify store to notify BotBaba of checkout creation events.
Input parameters
JSON payload of Shopify Checkout Creation event sent by Shopify
Webhook topic
Webhook delivery ID
API version
HMAC-SHA256 signature
Shop domain
Trigger timestamp
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_CHECKOUT_UPDATE_SHOPIFY_WEBHOOKTool to forward Shopify checkout/update events to Botbaba. Use when handling Shopify checkout update notifications.
Input parameters
The full JSON payload received from Shopify's 'checkout/update' webhook
Webhook topic, typically 'checkouts/update'
Webhook delivery ID
API version
HMAC-SHA256 signature
Shop domain
Trigger timestamp (ISO 8601)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_DELETE_BROADCASTTool to delete a broadcast campaign. Use when you need to permanently remove a Botbaba broadcast by its ID after confirming it exists.
Input parameters
Unique identifier of the broadcast campaign to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_DELETE_CONTACTTool to delete a contact. Use when you have the contact ID and want to remove it from Botbaba.
Input parameters
ID of the contact to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_DELETE_FLOWTool to delete a conversation flow. Use when you need to permanently remove a Botbaba flow by its ID after confirming it exists.
Input parameters
Unique identifier of the conversation flow to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_DELETE_TAGTool to delete a tag. Use when you have a tag ID and want to remove it from Botbaba. Tries multiple known Botbaba endpoint variations to improve compatibility across deployments.
Input parameters
ID of the tag to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_DELETE_TEMPLATETool to delete a message template. Use when you have the template ID and want to remove it from Botbaba. Tries multiple known Botbaba endpoint variations to improve compatibility across deployments.
Input parameters
Unique identifier of the message template to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_DELETE_WEBHOOKTool to delete a webhook subscription. Use when you have the webhook ID and want to remove it from Botbaba.
Input parameters
Unique identifier of the webhook subscription to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_EXECUTE_BOT_ACTIONTool to execute a bot action or workflow. Use when triggering automated actions or workflows for a specific conversation.
Input parameters
Name or identifier of the action to execute
Conversation ID where the action should be executed
Comma-separated tag IDs to associate with the action execution
ID of the bot action to execute
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_EXECUTE_BOT_ACTION_BY_USERTool to execute a bot action for specific users. Use when you need to trigger actions for one or multiple bot users.
Input parameters
The action name or type to execute
The unique identifier of the bot
The unique identifier of the action to execute
List of bot user IDs to execute the action for
Additional JSON payload for the action execution
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_GET_BOT_WIDGET_SETTINGSTool to retrieve widget configuration settings for a bot. Use when you need to check or verify the widget display settings, styling, or behavior configuration for a specific bot.
Input parameters
Unique identifier of the bot to retrieve widget settings for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_GET_BROADCASTTool to retrieve details of a specific broadcast. Use when you need to confirm broadcast settings or status after creating or scheduling a broadcast.
Input parameters
Unique identifier of the broadcast to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_GET_CONTACTTool to fetch a BotBaba contact by its ID. Use when you need to retrieve the full details of a contact after creation or update.
Input parameters
ID of the BotBaba contact to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_GET_CONTACT_ANALYTICSTool to retrieve analytics data for contacts. Use when you need summary metrics (e.g., new or active contacts) over a date range. Note: BotBaba API does not have a dedicated contact analytics endpoint. This action aggregates data from messages and tags to provide contact interaction metrics.
Input parameters
End date for analytics in ISO 8601 format (e.g., '2023-01-31').
Start date for analytics in ISO 8601 format (e.g., '2023-01-01').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_GET_FILENAMETool to extract the filename from a file path. Use when you need to parse a file path and retrieve just the filename component.
Input parameters
Full file path from which to extract the filename
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_GET_FLOWTool to retrieve details of a specific flow. Use when you need the full configuration for a given flow ID.
Input parameters
Unique identifier for the flow
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_GET_MESSAGETool to retrieve status of a specific message. Use after sending a message to check its delivery status.
Input parameters
Unique identifier of the message to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_GET_MESSAGE_ANALYTICSTool to retrieve analytics data for a specific message. Use after sending a message to analyze its delivery and engagement statistics.
Input parameters
Unique identifier of the message to retrieve analytics for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_GET_TEMPLATETool to retrieve details of a specific template. Use when you need to confirm template details before sending a message using a template.
Input parameters
Unique identifier of the template to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_GET_WEBHOOKTool to retrieve details of a specific webhook. Use when you need to confirm webhook configuration before debugging event deliveries.
Input parameters
Unique identifier of the webhook to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_LIST_BROADCASTSTool to list all broadcast campaigns. Use when retrieving BotBaba broadcast campaigns with pagination.
Input parameters
Number of broadcasts to retrieve per request (1-100)
Offset for pagination (starting index, zero-based)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_LIST_FLOWSTool to list all conversation flows with their IDs and metadata. Use when you need to retrieve all available flows from your BotBaba account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_LIST_TAGSTool to list all tags. Use when you need to retrieve all tags available in your Botbaba account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_LIST_TEMPLATESTool to retrieve a paginated list of templates. Use when you need to browse or manage existing templates; supports optional search filtering.
Input parameters
Page number to retrieve, must be ≥ 1
Number of templates per page
Search term to filter templates by name or content
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_LIST_WEBHOOK_EVENT_TYPESTool to list available webhook event types. Use before creating or updating a webhook to ensure you subscribe to valid event identifiers.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_LIST_WEBHOOKSTool to list all registered webhooks. Use when you need to retrieve and manage webhook subscriptions in your BotBaba account.
Input parameters
Number of webhooks to retrieve per request (1-100)
Offset for pagination (starting index, zero-based)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_ORDER_CANCELLATION_SHOPIFY_WEBHOOKTool to receive Shopify order cancellation webhooks. Use when handling Shopify orders/cancelled events from your store.
Input parameters
JSON payload of the Shopify order cancellation event
Webhook topic header; expected 'orders/cancelled'
Unique webhook delivery ID
Admin API version used to serialize the payload
HMAC-SHA256 signature to verify the webhook origin
Shop domain sending the webhook, e.g., store.myshopify.com
ISO-8601 timestamp when Shopify triggered the webhook
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_ORDER_FULFILLMENT_EVENT_SIMULATORTool to simulate a Shopify order fulfillment webhook payload. Use when generating test payloads for BOTBABA_ORDER_FULFILLMENT_SHOPIFY_WEBHOOK.
Input parameters
Variant of the fulfillment payload to simulate: 'standard', 'with_tracking', 'partial', or 'missing_location'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_ORDER_FULFILLMENT_SHOPIFY_WEBHOOKTool to receive Shopify Order Fulfillment webhooks. Use when handling Shopify fulfillments/create or fulfillments/update events from your store. This action acknowledges receipt of the webhook and extracts key fulfillment details.
Input parameters
Full JSON payload sent by Shopify for Order Fulfillment event
Webhook topic
Webhook delivery ID
API version
HMAC-SHA256 signature
Shop domain
Trigger timestamp
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_ORDER_PAYMENT_SHOPIFY_WEBHOOKTool to receive Shopify Order Payment webhooks. Use when handling Shopify orders/paid events from your store. This action acknowledges receipt of the webhook and extracts key payment details from the order.
Input parameters
Full JSON payload sent by Shopify for the Order Payment event
Webhook topic
Event identifier
Webhook delivery ID
API version
HMAC-SHA256 signature
Shop domain
Trigger timestamp
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_SEND_WHATSAPP_TEMPLATE_MESSAGESTool to forward/send a WhatsApp template message via Botbaba. Use after copying the full message JSON from the Template UI.
Input parameters
Full JSON payload for the template message, as generated by Botbaba's Template UI. Use the 'Copy Send Message Request' button to obtain this JSON.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_SHOPIFY_CHECKOUT_CREATION_EVENT_SIMULATORTool to simulate a Shopify checkout creation webhook payload. Use when generating test payloads for BOTBABA_CHECKOUT_CREATION_SHOPIFY_WEBHOOK.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_SHOPIFY_CHECKOUT_UPDATE_EVENT_SIMULATORTool to simulate a Shopify checkout update webhook payload. Use when generating test payloads for BOTBABA_CHECKOUT_UPDATE_SHOPIFY_WEBHOOK.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_UPDATE_CONTACTTool to update an existing contact. Use when needing to modify contact details after confirming contact_id.
Input parameters
List of tags associated with the contact
Email address of the contact
Phone number of the contact
Last name of the contact
The unique identifier of the contact to update
First name of the contact
Custom fields to update for the contact
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_UPDATE_TAGTool to update an existing tag. Use when renaming a tag after confirming its tag ID.
Input parameters
New name for the tag
Unique identifier of the tag to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_UPDATE_TEMPLATETool to update an existing message template. Use when you need to modify template details after confirming its template ID. Tries multiple base URLs, HTTP methods, and path variants to be resilient across different Botbaba deployments.
Input parameters
New name for the template
Type of the template, e.g., text or media
Updated content of the template with placeholders
List of parameters/placeholders definitions, if updating
Unique identifier of the template to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_UPDATE_WEBHOOKTool to update an existing webhook. Use when modifying webhook URL, events, or activation status after confirming the webhook ID.
Input parameters
New callback URL for the webhook
Whether the webhook is active or not
List of event types to subscribe to (e.g., \['message.incoming', 'contact.created'\])
Unique identifier of the webhook to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_WA_GUPSHUP_EVENT_SIMULATORTool to simulate Gupshup WhatsApp webhook events. Use when testing BOTBABA_WA_GUPSHUP_MESSAGE dispatcher with different event types.
Input parameters
Text body for 'message' events
Phone number of the message sender including country code, e.g., '919876543210'
Phone number of the message recipient including country code
Unix timestamp in milliseconds. Defaults to current time if not provided
Type of Gupshup webhook event to simulate
Unique message identifier. Required for delivery or read events
Interactive message payload for 'interactive' events
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTBABA_WA_GUPSHUP_MESSAGETool to forward inbound WhatsApp webhook events from Gupshup to Botbaba. Use when handling the POST callback from Gupshup's WhatsApp integration.
Input parameters
Entire JSON payload sent by Gupshup for the WhatsApp message/event
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 42 Botbaba actions on Nagent, including "Get Bot Widget Settings", "Get Broadcast" and "Get BotBaba Contact". Get Bot Widget Settings: Retrieve widget configuration settings for a bot. Each action is listed on this page with its input parameters and its output.
Botbaba connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get Bot Widget Settings takes 1 required input: bot_id. It returns data, error and successful.