NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Landbot connects to a Nagent workspace with an API key. Once it is connected, agents can call 13 Landbot actions, such as "Get Brand", "List Agents" and "List Bots". 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 Landbot, with input parameters and output schema.
LANDBOT_DELETE_BOTTool to delete a specific bot from your account. Use when you need to remove an unused or test bot after confirming the bot ID.
Input parameters
Unique identifier of the bot 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
LANDBOT_GET_BRANDTool to retrieve your brand data including contact information and settings. Use when you need to access brand profile details, configuration, or contact information.
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
LANDBOT_LIST_AGENTSTool to retrieve a list of agents in your Landbot account. Use after authenticating your account to enumerate all agents and their details.
Input parameters
Maximum number of records to return per request.
Number of records to skip before returning results.
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
LANDBOT_LIST_BOTSTool to list all bots in your Landbot account. Use after authenticating to discover your configured bots.
Input parameters
Maximum number of records to return per request.
Number of records to skip before returning results.
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
LANDBOT_LIST_CHANNELSTool to list all channels integrated with your account. Use after authenticating your account to enumerate available messaging channels and metadata.
Input parameters
Maximum number of records to return per request.
Number of records to skip before returning results.
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
LANDBOT_LIST_CUSTOMERSTool to list customers who have interacted with your bot. Use when you need to retrieve customer records with optional filters (channel_id, opt_in, search) and pagination.
Input parameters
Maximum number of records to return per request.
Number of records to skip before returning results.
Filter only customers who have opted in (e.g., WhatsApp opt-in).
Value to search for in the specified field.
Field to search by. Must be one of 'phone', 'email', or 'name'.
Filter by specific channel ID through which customers interact.
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
LANDBOT_LIST_WHATSAPP_TEMPLATESTool to list all WhatsApp message templates available for the account. Use after obtaining your WhatsApp channel ID to fetch template IDs and parameter counts.
Input parameters
Optional WhatsApp channel ID to filter templates and avoid duplicates
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
LANDBOT_REPLACE_AGENTTool to replace all data for a specific agent (full update). Use when you need to update agent information like name or password.
Input parameters
The unique identifier of the agent to replace.
New password for the agent. Must be provided with password_confirmation if changing password.
Agent last name.
Agent first name.
Password confirmation. Required when changing password.
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
LANDBOT_REPLACE_BRANDTool to replace or update brand data with a full update (PUT operation). Use when you need to change company branding information in your Landbot account.
Input parameters
Brand city name.
Brand name. This is the only required field for updating brand information.
Brand phone number. Include country code for international numbers.
Brand physical address or street address.
Brand country. Use ISO 3166-1 alpha-2 country codes (e.g., 'US', 'GB', 'ES').
Brand ZIP or postal code.
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
LANDBOT_SEND_MESSAGETool to send a plain text outbound message to a Landbot customer. Use when you need to reply to or continue a support chat with a known customer_id.
Input parameters
Plain text message to send to the customer.
Unique identifier of the customer to send the message to.
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
LANDBOT_SET_AGENT_STATUSTool to change your agent status to online, offline, or busy. Use when you need to update your availability status in Landbot.
Input parameters
New status for the agent. Must be one of: online, busy, or offline.
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
LANDBOT_UPDATE_AGENTTool to update an agent's information in your Landbot account. Use when you need to modify agent details such as name, email, or password. This performs a partial update.
Input parameters
Agent's email address.
Unique identifier of the agent to update.
New password for the agent.
Agent's last name.
Agent's first name.
Password confirmation, required if password is provided.
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
LANDBOT_UPDATE_BRANDTool to partially update your brand data in Landbot. Use when you need to modify brand information such as name, phone, address, city, zipcode, or country.
Input parameters
Brand city to update.
Brand name to update.
Brand phone number to update.
Brand address to update.
Brand country to update.
Brand zipcode 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
Agents can call 13 Landbot actions on Nagent, including "Get Brand", "List Agents" and "List Bots". Get Brand: Retrieve your brand data including contact information and settings. Each action is listed on this page with its input parameters and its output.
Landbot 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.
It returns data, error and successful.