NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Workiom connects to a Nagent workspace with an API key. Once it is connected, agents can call 3 Workiom actions: "Create record", "Get all lists" and "Get records". 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 Workiom, with input parameters and output schema.
WORKIOM_CREATE_RECORDCreates a new record in a specified Workiom list. This tool creates a record with basic field types like text, numbers, dates, and static list items. The record data should be provided as a JSON object where each key is a field ID and the value matches the expected data type for that field.
Input parameters
The ID of the list where the record will be created
A JSON object containing the field values for the new record. Each key should be a field ID, and the value should match the expected data type. Supported field types: strings for text, numbers for numeric fields, ISO 8601 date strings for dates, objects with {id, label} for static list items, and arrays of objects for linked records.
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
WORKIOM_GET_ALL_LISTSGet all lists from a Workiom app. This action fetches all lists within a specific Workiom app. Lists are containers for records (similar to database tables) and are the fundamental data structure in Workiom. Each list has a unique ID and contains views for displaying data. Use this action to discover available lists before performing operations like creating records (which require a list ID).
Input parameters
The ID of the Workiom app to fetch lists from. This is a UUID that can be obtained from the Apps/GetAll endpoint or from the URL when viewing the app in Workiom.
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
WORKIOM_GET_RECORDSRetrieves records from a specified Workiom list. Use this action to fetch data from a Workiom list. The list_id is required and can be obtained from the WORKIOM_GET_ALL_LISTS action. Each record contains field values keyed by numeric field IDs. Features: - Pagination: Use max_result_count and skip_count to paginate through large datasets - Sorting: Sort by any field using 'FIELD_ID ASC' or 'FIELD_ID DESC' format - Filtering: Apply conditions using filter operators (Contains, Is, Greater, etc.) Note: Field IDs are numeric (e.g., 5037173) and can be found in list metadata.
Input parameters
Optional array of filter conditions to apply. Multiple filters are combined with AND logic.
The UUID of the list to fetch records from. Obtain this from WORKIOM_GET_ALL_LISTS action.
Sort order in format 'FIELD_ID DIRECTION' where DIRECTION is ASC or DESC. Example: '5037173 ASC' sorts by field 5037173 ascending.
Number of records to skip from the beginning. Use with max_result_count for pagination (e.g., skip_count=10 with max_result_count=10 returns records 11-20).
Maximum number of records to return per request. Use with skip_count for pagination. Default is all records.
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 3 Workiom actions on Nagent: "Create record", "Get all lists" and "Get records". Create record: Creates a new record in a specified Workiom list. Each action is listed on this page with its input parameters and its output.
Workiom 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.
Create record takes 2 required inputs: list_id and record_data. It returns data, error and successful.