NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Beeminder connects to a Nagent workspace with an API key. Once it is connected, agents can call 5 Beeminder actions, such as "Create Charge", "Get all goals" and "Get Archived Goals". 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 Beeminder, with input parameters and output schema.
BEEMINDER_AUTHENTICATE_AND_REDIRECT_USERTool to authenticate a user and redirect them to a given URL. Use when sending a user into the Beeminder web UI directly after OAuth or token validation.
Input parameters
Beeminder username or 'me' to refer to the authenticated user
Fully qualified URL to redirect the user to after successful authentication. Must be URL-encoded.
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
BEEMINDER_CREATE_CHARGETool to create a new charge for a user. Use when billing a user outside of goal pledges; supports dryrun mode.
Input parameters
Explanation for why the charge is made
Amount to charge the user, in USD. Minimum is $1.00
If true, returns the charge JSON without creating the charge
Beeminder username of the user to charge
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
BEEMINDER_GET_ALL_GOALSTool to retrieve all goals for a specified user. Use when listing a user's active goals.
Input parameters
Beeminder username whose goals to retrieve. Use 'me' for the authenticated user.
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
BEEMINDER_GET_ARCHIVED_GOALSTool to retrieve archived goals for a specified user. Use when you need to inspect a user's past archived goals.
Input parameters
Beeminder username whose archived goals to retrieve. Use 'me' for the authenticated user.
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
BEEMINDER_GET_USER_INFORMATIONTool to retrieve information about a specified Beeminder user. Use when you need to fetch details like timezone, goals, urgency, or deleted goals after authenticating successfully.
Input parameters
When used with diff_since, return slim goal attributes and only the most recent datapoint for each goal.
Beeminder username to retrieve information for.
Unix timestamp in seconds; return only goals and datapoints created or updated since this time.
Whether to include full goal and datapoint objects instead of only slugs.
Number of most recent datapoints to return for each goal.
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 Beeminder actions on Nagent, including "Create Charge", "Get all goals" and "Get Archived Goals". Create Charge: Create a new charge for a user. Each action is listed on this page with its input parameters and its output.
Beeminder 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 Charge takes 2 required inputs: amount and user_id. It also takes 2 optional inputs: note and dryrun. It returns data, error and successful.