NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Magnetic connects to a Nagent workspace with an API key. Once it is connected, agents can call 14 Magnetic actions, such as "Get Current Follow-ups", "Search Client Contacts" and "Create Magnetic Grouping". 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 Magnetic, with input parameters and output schema.
MAGNETIC_CLIENTS_GET_CURRENT_FOLLOWUPSTool to retrieve upcoming follow-ups assigned to the authenticated user. Use after authentication to view scheduled tasks.
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
MAGNETIC_CLIENTS_SEARCH_CONTACTSTool to search contacts by field or client ID. Use when you need to retrieve client contacts matching given criteria after authentication.
Input parameters
The contact field to search by (e.g., 'email', 'name').
Maximum number of results to return.
The value to match in the specified field.
Number of items to skip for pagination.
Filter results to contacts belonging to this client 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
MAGNETIC_CREATE_GROUPINGTool to create a new opportunity or job (grouping) in Magnetic HQ. Use when you need to organize tasks and track project progress for a new opportunity or job.
Input parameters
Name of the new opportunity or job grouping
Description or additional details about the opportunity/job
The user who will be the owner of this grouping. Must provide user ID.
Contact object to associate with the grouping.
Company object to associate with the grouping.
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
MAGNETIC_CREATE_TASKTool to create a new task in Magnetic HQ. Use when you need to add tasks to the system, optionally assigning them to users or linking to opportunities.
Input parameters
Name of the task to create. This is the primary identifier displayed for the task.
Reference to a user to assign the task to.
End date or due date for the task in ISO 8601 format (e.g., '2024-01-20T17:00:00Z').
Whether time tracked on this task should be billable. Set to true for client-billable work.
Reference to a grouping/opportunity to associate with the task.
Start date for the task in ISO 8601 format (e.g., '2024-01-15T09:00:00Z').
Detailed description of the task. Can contain additional context or instructions.
Amount of time already tracked on this task, in minutes.
Estimated effort for this task, in minutes. Used for time estimation and planning.
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
MAGNETIC_GET_CONTACT_TAGSTool to get all tags associated with a contact. Use after confirming the contactId to list contact tags.
Input parameters
Unique ID of the contact whose tags 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
MAGNETIC_GET_GROUPING_BY_IDTool to retrieve details for a specific grouping (opportunity/job) by its ID. Use when you need detailed information about a specific grouping.
Input parameters
The unique ID of the grouping/opportunity to retrieve (must be positive).
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
MAGNETIC_GET_GROUPING_STATUSESTool to retrieve the list of statuses for signed groupings. Use after authentication when you need available grouping status options for tasks or jobs.
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
MAGNETIC_GET_GROUPING_TAGSTool to retrieve tags associated with any groupings owned by the company. Use after authentication when grouping tags are needed.
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
MAGNETIC_GET_OPPORTUNITY_STATUSESTool to retrieve opportunity statuses. Use when you need current status options for unsigned groupings (opportunities).
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
MAGNETIC_GET_TASKTool to retrieve a task by its ID. Use after confirming you have the taskId.
Input parameters
The unique ID of the task to retrieve (must be positive).
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
MAGNETIC_GET_USER_BY_IDTool to retrieve details for a specific Magnetic user by their ID. Use when you need to fetch a user's profile information.
Input parameters
The unique identifier of the user 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
MAGNETIC_GET_USERSTool to retrieve the list of all users in the authenticated user's company. Use after authentication to audit or manage user accounts.
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
MAGNETIC_LIST_COMPANIESTool to retrieve all companies from the Magnetic HQ account. Use after authentication to view all client companies.
Input parameters
Maximum number of companies to return.
Number of items to skip 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
MAGNETIC_TASKS_GET_GROUPING_CUSTOM_FIELD_DEFINITIONSTool to retrieve all custom field definitions for groupings. Use after authentication when you need to fetch available grouping custom field definitions for tasks.
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 14 Magnetic actions on Nagent, including "Get Current Follow-ups", "Search Client Contacts" and "Create Magnetic Grouping". Get Current Follow-ups: Retrieve upcoming follow-ups assigned to the authenticated user. Each action is listed on this page with its input parameters and its output.
Magnetic 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.