NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Passcreator connects to a Nagent workspace with an API key. Once it is connected, agents can call 11 Passcreator actions, such as "Create App Scan", "Get App Configuration" and "Get Process Status". 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 Passcreator, with input parameters and output schema.
PASSCREATOR_CHECK_PASS_EXISTENCETool to check if a pass exists for a given ID. Use when verifying pass existence before subsequent operations like updates or deletions. The ID can be a generatedId (unique ID created for every pass, usually encoded in the barcode), userProvidedId (optional custom ID), or any other identifier associated with a pass.
Input parameters
The pass identifier to check for existence. Can be a generatedId, userProvidedId, or any ID associated with a pass.
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
PASSCREATOR_CREATE_APP_SCANTool to create a new App Scan in PassCreator. Use when recording pass validation or attendance scanning events. Supports tracking scan status, device information, and optional pass voiding.
Input parameters
The pass identifier, or null if no pass was found
Timestamp in format YYYY-MM-DD HH:MM:SS
Whether to mark the pass as invalid after scanning. Optional field.
The device name performing the scan
Status indicator: pass_voided_after_scan (0), pass_already_voided (1), attendance_saved (2), or pass_not_found (3)
The unique ID of the App Configuration tied to this scan (UUID format)
The barcode value that was scanned
Key-value pairs where keys are property IDs and values are the corresponding data. Optional field.
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
PASSCREATOR_GET_APP_CONFIGURATIONRetrieves detailed information about an App Configuration by its identifier. Use when you need to get scan settings, UI customization, or validation rules for a specific App Configuration.
Input parameters
App Configuration identifier (UUID format, e.g., d0a467cf-391a-4b89-a00e-dc57a56d7b7b).
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
PASSCREATOR_GET_PROCESS_STATUSGet the current status and progress of a bulk operation including any errors. Use this to monitor long-running bulk operations like batch pass updates or creations. The identifier is returned when initiating a bulk operation.
Input parameters
The unique identifier (UUID) of the bulk operation process to check status 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
PASSCREATOR_GET_SIGNING_PUBLIC_KEYTool to obtain the public key needed to verify signatures from the placeholder sign() function. Use when you need to verify cryptographic signatures generated by Passcreator's sign placeholder.
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
PASSCREATOR_LIST_APP_CONFIGURATIONSRetrieves all App Configurations for your Passcreator account. Use this action to get a list of validation configurations that control how passes are scanned and validated. Each configuration can be linked to specific pass templates or validate all passes.
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
PASSCREATOR_LIST_APP_SCANSRetrieves a paginated list of scans for a given app configuration. Use this tool to view scan history, track attendance, and analyze scan data ordered by creation date.
Input parameters
Pagination offset - the starting index for results (default: 0).
Number of results per page (default: 100, max: 100).
Filter scans created after this datetime. Format: Y-m-d H:i (e.g., '2024-01-15 14:30').
App Configuration identifier (UUID format) to retrieve scans 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
PASSCREATOR_LIST_PASSESList and search wallet passes from Passcreator using the v3 API. Use this tool to: - Retrieve all passes in your account - Filter passes by template ID or project ID - Search passes using a search phrase across all data fields - Paginate through large result sets Returns passes with metadata including identifiers, serial numbers, template info, and voided/redeemed status.
Input parameters
Number of passes to return per page (10-1000, default 100).
Filter passes by project ID (UUID format). Only return passes belonging to this project.
Filter passes by pass template ID (UUID format). Only return passes created from this template.
Wildcard search phrase to match across all pass data fields. Use for general text searching.
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
PASSCREATOR_LIST_PASS_TEMPLATESRetrieves all pass templates for your Passcreator account. Use this action to get a list of available templates (each with its unique identifier and name) which are needed to create new passes. Templates must be created via the Passcreator web app.
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
PASSCREATOR_SEND_BULK_PUSH_NOTIFICATIONSTool to send push notifications to multiple wallet passes simultaneously (up to 500 passes). Use when you need to notify pass holders about updates, events, or important information. The notification text can include personalization placeholders like {Firstname}.
Input parameters
An array of pass identifiers (UID, userProvidedId, or barcode value). Maximum 500 identifiers per request.
The text for the push notification. May include placeholders like {Firstname} for personalization.
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
PASSCREATOR_UPDATE_PASSES_BULKTool to bulk update multiple wallet passes using filter criteria. Returns immediately with a tracking URL to monitor the asynchronous bulk operation progress. Use when updating many passes at once with the same data changes.
Input parameters
Object containing the fields to update on all matched passes. Replaces existing data for the specified fields. Common fields include: void (bool), expiry (string), custom field values, etc.
Filter criteria to select which passes to update. Must specify at least one of: identifiers, segmentId, or query.
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 11 Passcreator actions on Nagent, including "Create App Scan", "Get App Configuration" and "Get Process Status". Create App Scan: Create a new App Scan in PassCreator. Each action is listed on this page with its input parameters and its output.
Passcreator 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 App Scan takes 5 required inputs: createdOn, deviceName, scanStatus, appConfigurationId and scannedBarcodeValue. It also takes 3 optional inputs: passId, setVoided and additionalProperties. It returns data, error and successful.