NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Respond.io connects to a Nagent workspace with an API key. Once it is connected, agents can call 7 Respond.io actions, such as "Add internal comment to conversation", "Create Contact" and "Create Space Tag". 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 Respond.io, with input parameters and output schema.
RESPOND_IO_CREATE_COMMENTTool to add a comment (internal note) to a contact's conversation. Use after verifying the contact identifier.
Input parameters
Content of the comment (internal note), up to 1000 characters. You can mention other users using `{{@user.ID}}`.
Identifier of the contact; either 'id:<contact_id>', 'email:<email>' or 'phone:<E.164_phone>'. Example: 'id:123', 'email:abdc@gmail.com', 'phone:+60121233112'
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
RESPOND_IO_CREATE_CONTACTCreates a new contact in the respond.io workspace with the specified details. The contact is identified by email, phone number, or contact ID. Supports adding profile information, language preferences, and custom fields that have been pre-configured in the workspace.
Input parameters
Email address of the contact
Phone number of the contact including country code
ISO 639-1 two-letter language code (e.g., 'en' for English, 'es' for Spanish)
Last name of the contact
First name of the contact
Unique identifier for the contact in one of these formats: 'email:<email_address>' (e.g., 'email:john@example.com'), 'phone:<phone_number>' (e.g., 'phone:+60121233112' with country code), or an existing contact ID
URL of the contact's profile picture
ISO 3166-1 alpha-2 two-letter country code (e.g., 'US' for United States, 'MY' for Malaysia)
List of custom fields for the contact. Note: Custom fields must already exist in the workspace before they can be assigned to a 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
RESPOND_IO_CREATE_SPACE_TAGCreates a new tag in the Respond.io workspace for organizing and categorizing contacts and conversations. Tags help with segmentation, filtering, and workflow automation. Each tag must have a unique name within the workspace.
Input parameters
Name of the tag. Must be unique within the workspace. Cannot contain emojis or certain invalid characters. Supports spaces, letters, numbers, and common special characters like !@#$%.
(Optional) Hexadecimal color code for visual identification of the tag in the UI, e.g., '#FF5733'. Note: Currently the API may reject this parameter with validation errors.
(Optional) Brief text describing the tag's purpose or usage. Helps team members understand when to apply this tag.
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
RESPOND_IO_GET_MESSAGETool to retrieve a specific message. Use when you need the details of a message sent to or received from a contact.
Input parameters
Unique ID of the message to retrieve.
Identifier of the contact, can be a phone number ('+60121233112'), email ('abdc@gmail.com'), or contact ID prefixed by 'id:' (e.g., 'id:123').
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
RESPOND_IO_LIST_CHANNELSTool to retrieve a list of channels connected to the workspace. Use when you need to enumerate all messaging channels with pagination support.
Input parameters
Number of items to return (page size). Default is 10, maximum 100.
Pointer to the channel ID from where the next batch of records should start.
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
RESPOND_IO_LIST_USERSTool to retrieve a list of users in the workspace. Use when you need to fetch all workspace users for auditing or assignment.
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
RESPOND_IO_UPDATE_SPACE_TAGUpdates an existing workspace tag by its current name. You can modify the tag's name, description, or emoji. Note: Color codes are not currently supported by the API and will be rejected if provided. At least one field besides currentName must be provided to update.
Input parameters
New name for the tag (if you want to rename it)
Emoji to associate with the tag (single emoji character)
Hex color code for the tag (Note: Currently not supported by API and will return error if provided)
The current name of the tag you want to update (must match exactly)
New description for the tag (updates or sets the description)
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 7 Respond.io actions on Nagent, including "Add internal comment to conversation", "Create Contact" and "Create Space Tag". Add internal comment to conversation: Add a comment (internal note) to a contact's conversation. Each action is listed on this page with its input parameters and its output.
Respond.io 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.
Add internal comment to conversation takes 2 required inputs: text and identifier. It returns data, error and successful.