NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Gorgias connects to a Nagent workspace with an API key. Once it is connected, agents can call 32 Gorgias actions, such as "Add Ticket Tags", "Create Account Setting" and "Create Customer". 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 Gorgias, with input parameters and output schema.
GORGIAS_ADD_TICKET_TAGSAdds tags to a ticket in Gorgias.
Input parameters
List of tag IDs to add to the ticket
The ID of the ticket
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
GORGIAS_CREATE_ACCOUNT_SETTINGCreates a new account setting in Gorgias.
Input parameters
The name of the setting
The value of the setting
Description of the setting
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
GORGIAS_CREATE_CUSTOMERCreates a new customer in Gorgias.
Input parameters
Additional customer data
The customer's full name
The customer's email address
The customer's address information
The customer's communication channels
External identifier for the customer
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
GORGIAS_CREATE_TEAMCreates a new team in Gorgias.
Input parameters
Name of the team
The list of users within the team
Object describing how the team appears on the webpage
Longer description of the team
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
GORGIAS_CREATE_TICKETCreates a new ticket in Gorgias.
Input parameters
How the first message of the ticket has been received or sent from Gorgias
Extra metadata about the ticket
List of tag IDs to apply to the ticket
The status of the ticket
The channel of the ticket (email, chat, etc.)
The subject of the ticket
Customer information (id, name, or email)
The language of the ticket
Messages of the ticket
The priority of the ticket
External identifier for the ticket
ID of the team to assign the ticket to
ID of the user to assign the ticket 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
GORGIAS_DELETE_CUSTOMERDeletes a specific customer from Gorgias.
Input parameters
The ID of the customer 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
GORGIAS_DELETE_CUSTOMER_FIELD_VALUEDeletes a specific field value for a customer in Gorgias.
Input parameters
The ID of the custom field
The ID of the customer
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
GORGIAS_DELETE_CUSTOMERSDeletes multiple customers from Gorgias.
Input parameters
List of customer IDs 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
GORGIAS_DELETE_TEAMDeletes a specific team from Gorgias.
Input parameters
The ID of the team 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
GORGIAS_DELETE_TICKETDeletes a specific ticket from Gorgias.
Input parameters
The ID of the ticket 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
GORGIAS_DELETE_TICKET_FIELD_VALUEDeletes a specific field value for a ticket in Gorgias.
Input parameters
The ID of the custom field
The ID of the ticket
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
GORGIAS_GET_ACCOUNTRetrieves your Gorgias account 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
GORGIAS_GET_CUSTOMERRetrieves a specific customer from Gorgias.
Input parameters
The ID of the customer 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
GORGIAS_GET_EVENTRetrieves a specific event from Gorgias.
Input parameters
The ID of the event 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
GORGIAS_GET_TEAMRetrieves a specific team from Gorgias.
Input parameters
The ID of the team 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
GORGIAS_GET_TICKETRetrieves a specific ticket from Gorgias.
Input parameters
The ID of the ticket 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
GORGIAS_LIST_ACCOUNT_SETTINGSLists all account settings in Gorgias.
Input parameters
Number of settings to return (default: 20, max: 100)
Offset for pagination
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
GORGIAS_LIST_CUSTOMER_FIELD_VALUESLists all field values for a customer in Gorgias.
Input parameters
The ID of the customer
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
GORGIAS_LIST_CUSTOMERSLists customers in Gorgias with various filtering options.
Input parameters
Filter by customer name
Filter by customer email
Number of customers to return (default: 20, max: 100)
Offset for pagination
Field to order by (e.g., 'created_datetime')
Order direction ('asc' or 'desc')
Filter by creation date (ISO format)
Filter by external ID
Filter by creation date (ISO format)
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
GORGIAS_LIST_EVENTSLists events in Gorgias with various filtering options.
Input parameters
Filter by event type
Number of events to return ( max: 100)
Offset for pagination
Filter by context UUID
Filter by user ID
Filter by object ID
Filter by creation date (ISO format)
Filter by object type
Filter by creation date (ISO format)
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
GORGIAS_LIST_TEAMSLists teams in Gorgias.
Input parameters
Maximum number of teams to return per page (default: 20, max: 100).
Cursor for pagination. Use the value of 'meta.next_cursor' from a previous response to fetch the next page.
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
GORGIAS_LIST_TICKET_FIELD_VALUESLists all field values for a ticket in Gorgias.
Input parameters
The ID of the ticket
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
GORGIAS_LIST_TICKETSLists tickets in Gorgias with various filtering options.
Input parameters
Number of tickets to return (default: 20, max: 100)
Offset for pagination
Filter by ticket status
Filter by tag ID
Filter by ticket channel
Filter by language
Field to order by (e.g., 'created_datetime')
Filter by ticket priority
Order direction ('asc' or 'desc')
Filter by creation date (ISO format)
Filter by update date (ISO format)
Filter by customer ID
Filter by external ID
Filter by creation date (ISO format)
Filter by update date (ISO format)
Filter by assigned team ID
Filter by assigned user ID
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
GORGIAS_LIST_TICKET_TAGSLists all tags for a ticket in Gorgias.
Input parameters
The ID of the ticket
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
GORGIAS_MERGE_CUSTOMERSMerges two customers in Gorgias, combining their data and history.
Input parameters
The ID of the source customer (will be merged into the target)
The ID of the target customer (will remain after merge)
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
GORGIAS_REMOVE_TICKET_TAGSRemoves tags from a ticket in Gorgias.
Input parameters
List of tag IDs to remove from the ticket
The ID of the ticket
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
GORGIAS_SET_CUSTOMER_DATASets the complete data object for a customer in Gorgias.
Input parameters
The complete data object to set for the customer
The ID of the customer
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
GORGIAS_SET_TICKET_TAGSSets the complete list of tags for a ticket in Gorgias.
Input parameters
List of tag IDs to set for the ticket
The ID of the ticket
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
GORGIAS_UPDATE_ACCOUNT_SETTINGUpdates an existing account setting in Gorgias.
Input parameters
The new value of the setting
The ID of the setting to update
Updated description of the setting
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
GORGIAS_UPDATE_CUSTOMERUpdates an existing customer in Gorgias.
Input parameters
Additional customer data
The customer's full name
The customer's email address
The customer's address information
The customer's communication channels
The ID of the customer to update
External identifier for the customer
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
GORGIAS_UPDATE_TEAMUpdates an existing team in Gorgias.
Input parameters
Name of the team
The list of users within the team
The ID of the team to update
Object describing how the team appears on the webpage
Longer description of the team
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
GORGIAS_UPDATE_TICKETUpdates an existing ticket in Gorgias.
Input parameters
Extra metadata about the ticket
The status of the ticket
The subject of the ticket
The language of the ticket
The priority of the ticket
The ID of the ticket to update
The ID of the customer for this ticket
External identifier for the ticket
ID of the team to assign the ticket to
ID of the user to assign the ticket 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
Agents can call 32 Gorgias actions on Nagent, including "Add Ticket Tags", "Create Account Setting" and "Create Customer". Add Ticket Tags: Adds tags to a ticket in Gorgias. Each action is listed on this page with its input parameters and its output.
Gorgias 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 Ticket Tags takes 2 required inputs: tag_ids and ticket_id. It returns data, error and successful.