NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Cardly connects to a Nagent workspace with an API key. Once it is connected, agents can call 29 Cardly actions, such as "Create Contact List", "Create Invitation" and "Create Webhook". 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 Cardly, with input parameters and output schema.
CARDLY_CREATE_CONTACT_LISTTool to add a new contact list. Use after defining name and optional custom fields, before populating the list with contacts.
Input parameters
A short, unique name for this contact list.
Custom fields to add to this list. New fields will be created; existing fields (matched by name) updated.
Free-text description of this contact list.
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
CARDLY_CREATE_INVITATIONTool to send an invitation to use your organisation portal. Use when you need to grant access to a new user by their email address. If the email already has access, the API will return an appropriate error.
Input parameters
An email address for the user to invite. Required.
The last name of the user being invited.
The first name of the user being invited.
Zero or more permission identifiers denoting the privileges to grant the user once they accept your invitation. If omitted, the user will have default permissions.
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
CARDLY_CREATE_WEBHOOKTool to create a new webhook subscription. Use when you need Cardly to notify your application via HTTP POST for specific events.
Input parameters
List of event names this webhook subscribes to; only notifications for these events will be sent.
Arbitrary key/value pairs to attach to this webhook for user-defined metadata.
The URL this webhook will send POST requests to once one of the subscribed events is triggered. Must be a valid HTTPS endpoint.
Free-text description of what this webhook is for.
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
CARDLY_DELETE_INVITATIONTool to delete an invitation by unique ID, immediately invalidating it for acceptance. Use when you need to revoke a pending invitation using its ID.
Input parameters
The unique ID of the invitation to revoke.
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
CARDLY_DELETE_INVITATION_BY_EMAILDeletes a pending invitation by email address, immediately invalidating it and preventing acceptance. This action is idempotent - deleting a non-existent invitation returns success. Use when you need to revoke access before an invitation is accepted, such as when correcting mistakes or revoking access for security reasons. Note: In test mode, the API returns an empty data object instead of the deleted invitation details.
Input parameters
The exact email address of the invitation to delete. Must match the email used when the invitation was created.
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
CARDLY_DELETE_USERTool to delete a user by unique ID, immediately revoking their access to your organisation portal. Use when removing user access is required. Cannot remove users with administrator privileges - attempting to delete an admin will fail.
Input parameters
The unique ID of the user to delete. This immediately revokes their access to your organisation portal. Cannot remove users with administrator privileges.
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
CARDLY_DELETE_USER_BY_EMAILDeletes a user by email address, immediately revoking their access to your organisation portal. This action cannot remove users with administrator privileges. Use when you need to revoke user access, such as when employees leave or access needs to be terminated. The API returns a 404 if no matching user is found.
Input parameters
The email address of the user to delete. This will immediately revoke their access to your organisation portal. Cannot remove users with administrator privileges.
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
CARDLY_DELETE_WEBHOOKTool to delete a webhook. Use after confirming the webhook ID to immediately cease all activity and event subscriptions for that webhook.
Input parameters
The unique ID of the webhook 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
CARDLY_ECHO_REQUESTTool to echo all request parameters, body, and headers for debugging purposes. Use when validating authentication or testing API connectivity without affecting account data.
Input parameters
A body parameter which will be returned to you in the response.
A body parameter which will be returned to you in the response.
An example query parameter which will be returned to you in the response.
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
CARDLY_GENERATE_PREVIEWTool to generate a low-quality, watermarked preview document for a card. Use after confirming artwork and template details to estimate costs and delivery.
Input parameters
Global style overrides (optional)
Sender details (provide all fields if specifying)
Artwork UUID to preview (obtain from LIST_ARTWORK action)
Message overrides when not using a template
True to send a blank envelope back to sender
Template ID for variable substitution (optional)
Envelope recipient details
Key/value map of template variables to inject
Shipping method (per-region support varies)
Desired arrival date (ISO 8601) for estimates
Reference number for internal tracking
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
CARDLY_GET_ARTWORKTool to retrieve information on a specific piece of artwork by its unique ID. Use when you need to fetch detailed artwork data including preview images, media specifications, and metadata. The ID can be obtained from the List Artwork action.
Input parameters
The unique ID of the artwork you wish 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
CARDLY_GET_WEBHOOKTool to get details on an existing webhook. Use this to retrieve information about a webhook's configuration, including its target URL, subscribed events, status, and metadata.
Input parameters
The unique ID of the webhook 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
CARDLY_LIST_ARTWORKTool to retrieve the currently available artwork for your organisation. Use when you need to list and paginate artwork items, optionally filtering to only your own artwork.
Input parameters
Maximum number of artwork items to return
Number of records to skip before returning results
If true, return only artwork owned by your organisation; defaults to false
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
CARDLY_LIST_CONTACT_LISTSTool to retrieve all active contact lists for your organization. Use when you need to list and paginate contact lists with their custom fields and automation rules.
Input parameters
Maximum number of contact lists to return. Defaults to API default if omitted.
Number of records to skip before returning results. Defaults to 0 if omitted.
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
CARDLY_LIST_CREDIT_HISTORYRetrieves the account's credit transaction history showing all credits and debits. Returns a paginated list of balance changes with timestamps, amounts, and descriptions. Use to audit spending, review signup bonuses, track refunds, or investigate balance changes. Filter by date range using effectiveTime parameters. Supports standard pagination with limit and offset.
Input parameters
Maximum number of records to retrieve per page, must be at least 1.
Number of records to skip before starting to collect the result set, must be non-negative.
Filter transactions after this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., '2024-01-01 00:00:00').
Filter transactions before this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., '2024-01-01 00:00:00').
Filter transactions at or after this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., '2024-01-01 00:00:00').
Filter transactions before or at this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., '2024-01-31 23:59:59').
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
CARDLY_LIST_DOODLESRetrieve your currently available doodles from Cardly. Returns doodle metadata including name and restriction status. Use this to discover available doodle designs before creating cards.
Input parameters
If true, return only doodles that are exclusive to your organisation. Set to false (default) to see all available doodles.
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
CARDLY_LIST_FONTSList available fonts for handwriting and text personalization in Cardly cards. Returns font metadata including name, category, variants, and whether the font supports humanisation. Use this to discover font options before creating cards or generating previews.
Input parameters
Maximum number of font records to return per page. Defaults to 25. Use lower values for faster responses or higher values to reduce pagination.
Number of font records to skip for pagination. Use 0 for the first page, then increment by limit for subsequent pages.
Filter to show only organization-exclusive custom fonts. Set to false (default) to see all available fonts including public ones.
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
CARDLY_LIST_GIFT_CREDIT_HISTORYLists gift credit history records for your organization with pagination and optional time-based filtering. Gift credits are promotional credits that can be applied to orders. This action retrieves a history of gift credit additions, deductions, and balance changes. Returns empty results if no gift credit history exists.
Input parameters
Maximum number of records to return per page. Must be at least 1. Defaults to 25 if not specified.
Number of records to skip before returning results (for pagination). Must be non-negative. Defaults to 0 if not specified.
Filter for records after this time. Format: 'YYYY-MM-DD HH:MM:SS' (e.g., '2024-01-01 00:00:00').
Filter for records before this time. Format: 'YYYY-MM-DD HH:MM:SS' (e.g., '2024-12-31 23:59:59').
Filter for records at or after this time. Format: 'YYYY-MM-DD HH:MM:SS' (e.g., '2024-01-01 00:00:00').
Filter for records before or at this time. Format: 'YYYY-MM-DD HH:MM:SS' (e.g., '2024-12-31 23:59:59').
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
CARDLY_LIST_INVITATIONSTool to retrieve active invitations for your organisation with optional filters. Use when you need to audit invited users and their statuses before sending new invitations or revoking access.
Input parameters
Maximum number of invitations to return. Defaults to API default if omitted.
Number of invitation records to skip before returning results. Defaults to 0 if omitted.
If true, only return expired invitations.
If true, only return accepted invitations.
If true, includes accepted invitations in the response. Default filters them out.
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
CARDLY_LIST_MEDIATool to retrieve the currently available media sizes for product artwork. Use when you need to explore or validate media options before creating artwork.
Input parameters
Maximum number of media items to return, defaults to 25 if omitted.
Number of records to skip for pagination, defaults to 0 if omitted.
If true, only return media items exclusive to your organisation.
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
CARDLY_LIST_ORDERSRetrieves a paginated list of orders placed by your organization. Returns detailed order information including customer details, costs, items, shipping info, and delivery tracking. Use optional limit and offset parameters to control pagination.
Input parameters
Maximum number of orders to return. Defaults to API default if omitted.
Number of records to skip before returning results. Defaults to 0 if omitted.
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
CARDLY_LIST_TEMPLATESTool to retrieve your currently available templates from Cardly. Use to list and paginate templates for selection in card sends.
Input parameters
Maximum number of templates to return. Defaults to API default if omitted.
Number of records to skip before returning results. Defaults to 0 if omitted.
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
CARDLY_LIST_USERSTool to retrieve all users associated with your account. Use when you need to list and paginate user accounts.
Input parameters
Maximum number of users to return. Defaults to API default if omitted.
Number of user records to skip before returning results. Defaults to 0 if omitted.
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
CARDLY_LIST_WEBHOOKSRetrieves all webhooks configured for your organization, including their status, target URLs, subscribed events, and delivery statistics. Use this to audit existing webhooks, monitor their health, or get webhook IDs for updates/deletions.
Input parameters
Maximum number of webhooks to return. Defaults to API default if omitted.
Number of webhook records to skip before returning results. Defaults to 0 if omitted.
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
CARDLY_LIST_WRITING_STYLESTool to list available writing styles. Use when you need to retrieve writing styles available for handwriting personalization.
Input parameters
Number of records to return, defaults to 25 if omitted.
Number of records to skip for pagination, defaults to 0 if omitted.
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
CARDLY_RETRIEVE_ACCOUNT_BALANCETool to retrieve the current account and gift credit balances for your organisation. Use after authenticating to verify available credit before placing orders.
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
CARDLY_RETRIEVE_ORDERRetrieves detailed information about a specific order by its ID. Returns complete order data including customer details, items, costs, delivery information, and tracking details. Use this after obtaining an order ID from the List Orders action or from a known order reference.
Input parameters
The unique UUID of the order to retrieve. Obtain this from the List Orders action or from order creation responses.
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
CARDLY_RETRIEVE_USERRetrieves detailed information about a specific user account by ID. Returns user profile data including name, email, status, and permissions. Use list_users to get available user IDs first.
Input parameters
The unique UUID identifier of the user to retrieve. Obtain this from the list_users action.
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
CARDLY_UPDATE_WEBHOOKTool to update a webhook’s settings, including target URL and events. Use after retrieving existing webhook to apply configuration changes.
Input parameters
The unique ID of the webhook to update.
List of event names this webhook subscribes to; only notifications for these events will be sent.
If true, disables the webhook; if false, enables it.
Arbitrary key/value pairs to attach to this webhook for user-defined metadata.
The URL this webhook will send POST requests to once one of its subscribed events is triggered.
Free-text description of what this webhook is for.
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 29 Cardly actions on Nagent, including "Create Contact List", "Create Invitation" and "Create Webhook". Create Contact List: Add a new contact list. Each action is listed on this page with its input parameters and its output.
Cardly 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 Contact List takes 1 required input: name. It also takes 2 optional inputs: fields and description. It returns data, error and successful.