Remarkety connects to a Nagent workspace with an API key. Once it is connected, agents can call 5 Remarkety actions, such as "Get Remarkety Campaigns", "Get Remarkety Customers" and "Get Remarkety Products". 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 Remarkety, with input parameters and output schema.
REMARKETY_GET_CAMPAIGNSTool to retrieve a list of marketing campaigns. Use when you need to page through campaigns with optional limit and skip.
Input parameters
Number of campaigns to skip
Number of campaigns to return per request (1-1000)
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
REMARKETY_GET_CUSTOMERSTool to retrieve customers. Use when you need to fetch a paginated list of customers from a Remarkety store.
Input parameters
Number of results to return (optional)
Number of results to skip (optional)
Return customers updated before this date (ISO8601)
Return customers updated after this date (ISO8601)
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
REMARKETY_GET_PRODUCTSTool to retrieve products. Use when you need to fetch a paginated list of products from a Remarkety store.
Input parameters
Number of products to return (optional, default server-defined)
Number of products to skip (optional)
Filter by specific product ID (SKU)
Return products created before this date (ISO8601)
Return products created after this date (ISO8601)
Return products updated before this date (ISO8601)
Return products updated after this date (ISO8601)
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
REMARKETY_TRACK_CARTTool to track cart events in Remarkety. Use after a customer updates their cart to sync cart data for remarketing.
Input parameters
Cart recovery URL
Customer's email address
List of items in the cart
Customer's phone number
Unique cart identifier
Additional custom fields for the cart
Customer's last name
Cart subtotal amount, non-negative
Customer's first name
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
REMARKETY_UPLOAD_CONTACTS_BATCHTool to upload or update multiple contacts in batch. Use when you need to import or synchronize many contacts at once.
Input parameters
List of contact objects to upload or 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 5 Remarkety actions on Nagent, including "Get Remarkety Campaigns", "Get Remarkety Customers" and "Get Remarkety Products". Get Remarkety Campaigns: Retrieve a list of marketing campaigns. Each action is listed on this page with its input parameters and its output.
Remarkety 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 also takes 2 optional inputs: skip and limit. It returns data, error and successful.