NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Bidsketch connects to a Nagent workspace with an API key. Once it is connected, agents can call 38 Bidsketch actions, such as "Create Client", "Create Proposal" and "Get Client". 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 Bidsketch, with input parameters and output schema.
BIDSKETCH_CREATE_CLIENTTool to create a client. Use when adding a new client record to Bidsketch.
Input parameters
City in the client's address.
Client's full name or company name.
Client's primary email address.
Notes about the client; quotes need not be escaped.
Client's primary phone number.
State in the client's address.
Country in the client's address.
Client's website.
Client's alternate phone number.
Client's last name if they are a person.
Client's first name if they are a person.
Postal or ZIP code of the client's address.
Secondary contact information for client creation.
First line of the client's address.
Second line of the client's address.
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
BIDSKETCH_CREATE_PROPOSALTool to create a new proposal. Use when you need to create a proposal for a client with a name, description, and other details.
Input parameters
Tax as decimal (e.g., 0.1 for 10%).
The proposal's name/title.
Secondary tax as decimal (e.g., 0.05 for 5%).
ISO currency code (e.g., USD, EUR, GBP).
Discount as decimal (e.g., 0.1 for 10%).
Settings for the proposal.
The ID of the client for this proposal.
A summary of the proposal.
Date for the proposal in MM/DD/YYYY format.
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
BIDSKETCH_DELETE_CLIENTTool to delete a client and all their proposals. Use when you want to permanently remove a client and its associated proposals from your account.
Input parameters
The unique identifier of the client 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
BIDSKETCH_DELETE_FEETool to delete a fee. Use when a saved fee is no longer needed. Use after confirming this fee isn't referenced in any live proposals.
Input parameters
Unique ID of the fee 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
BIDSKETCH_DELETE_PROPOSALTool to delete a proposal and all its content. Use after confirming the proposal ID to prevent accidental deletions.
Input parameters
The unique identifier of the proposal 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
BIDSKETCH_DELETE_PROPOSAL_FEETool to delete a proposal fee. Use when you need to remove an existing fee before finalizing or sending a proposal.
Input parameters
The ID of the fee to delete.
ID of the proposal containing the fee.
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
BIDSKETCH_DELETE_PROPOSAL_SECTIONTool to delete a proposal section. Use when you need to remove a section from a proposal after verifying its ID.
Input parameters
ID of the section to delete
ID of the proposal containing the section 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
BIDSKETCH_DELETE_SECTIONTool to delete a section. Use when you need to permanently remove a saved section after confirming its ID.
Input parameters
The ID of the section 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
BIDSKETCH_DELETE_WEBHOOKPermanently delete a webhook subscription by ID. This removes the webhook and stops all future event notifications to its endpoint. Use this tool when you no longer need to receive events at a specific webhook URL, or when cleaning up test webhooks. Returns HTTP 204 No Content on success, or HTTP 404 if the webhook ID doesn't exist.
Input parameters
The unique ID of the webhook to permanently delete. This removes the webhook subscription and stops all future event notifications to the endpoint.
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
BIDSKETCH_GET_CLIENTTool to get a client by ID. Use when you need detailed client info after obtaining its ID.
Input parameters
The unique identifier of the client 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
BIDSKETCH_GET_CLIENT_PROPOSALSTool to list proposals for a specific client. Use after confirming the client ID exists.
Input parameters
The ID of the client whose proposals 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
BIDSKETCH_GET_CLIENTSTool to retrieve all clients. Use when you need to list all clients on the account.
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
BIDSKETCH_GET_FEETool to get a single fee. Use when you need detailed information about a fee by its ID after confirming its existence.
Input parameters
Unique ID of the fee 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
BIDSKETCH_GET_FEESTool to list all the fees for the account. Use when you need to fetch every saved fee.
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
BIDSKETCH_GET_PROPOSALTool to get a proposal by ID. Use when you need detailed information for a specific proposal after obtaining its ID.
Input parameters
The unique identifier of the proposal 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
BIDSKETCH_GET_PROPOSAL_CONTENTTool to get a proposal with all its content (sections and fees). Use when you need a full proposal in one call.
Input parameters
ID of the proposal to retrieve content 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
BIDSKETCH_GET_PROPOSAL_FEETool to get a single fee item for a proposal. Use when you need detailed information about a specific fee before updating or displaying it.
Input parameters
ID of the fee to retrieve within the proposal.
ID of the proposal containing the fee.
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
BIDSKETCH_GET_PROPOSAL_FEESTool to list all fees for a proposal. Use after confirming the proposal ID exists; supports pagination.
Input parameters
Page number for pagination.
Number of items per page for pagination.
ID of the proposal to list fees 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
BIDSKETCH_GET_PROPOSALSTool to retrieve all proposals for the account. Use when you need an overview of existing proposals.
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
BIDSKETCH_GET_PROPOSAL_SECTIONTool to fetch a single proposal section. Use when you need detailed information for a section after listing proposal sections.
Input parameters
ID of the specific section to retrieve
ID of the proposal containing the section 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
BIDSKETCH_GET_PROPOSAL_SECTIONSTool to get all sections for a proposal. Use when you need to list opening or closing sections by proposal ID.
Input parameters
ID of the proposal to retrieve sections 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
BIDSKETCH_GET_PROPOSAL_STATSGet proposal statistics for your Bidsketch account. This endpoint retrieves the total count of proposals in your account, including all proposals regardless of their status (draft, sent, won, lost, or archived). Use this when you need to: - Get a quick overview of total proposal count - Track the number of proposals created over time - Display proposal statistics in dashboards or reports No parameters required - simply call this action to get the current proposal count.
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
BIDSKETCH_GET_SECTIONTool to fetch a section by ID. Use when you need detailed section information after confirming its ID.
Input parameters
The unique identifier of the section 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
BIDSKETCH_GET_SECTIONSRetrieves all reusable proposal sections saved to your Bidsketch account. Sections are text blocks that can be included in proposals, categorized as 'opening' (appear at the start) or 'closing' (appear at the end). Use this to browse available sections before adding them to proposals.
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
BIDSKETCH_GET_TEMPLATESRetrieves all proposal templates saved in the account. Templates contain predefined sections, fees, and structure that can be used to create new proposals. Use this action to discover available templates before creating proposals or to display template options to users.
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
BIDSKETCH_LIST_PROPOSAL_CLOSING_SECTIONSTool to get a collection of closing sections for a proposal. Closing sections appear at the end of the proposal. Use when you need to retrieve all closing sections for a specific proposal.
Input parameters
The unique ID of the proposal to retrieve closing sections 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
BIDSKETCH_LIST_PROPOSAL_OPENING_SECTIONSTool to get a collection of opening sections for a proposal. Opening sections appear first in the proposal. Use when you need to retrieve all opening sections for a specific proposal.
Input parameters
The unique ID of the proposal to retrieve opening sections 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
BIDSKETCH_POST_FEETool to create a fee. Use when you need to add a reusable fee to the account before adding it to a proposal. Ensure required fields are set (e.g., unit for custom fees).
Input parameters
Name of the fee to create.
Unit label for custom fees. Required only when feetype is 'custom'.
Fee amount. For fixed fees, this is a total; for calculated fees, this is the amount per unit.
Type of fee. Must be one of 'fixed', 'hourly', 'monthly', 'yearly', or 'custom'.
A fee category to group fees together.
Quantity used for calculated fees.
HTML formatted description for the fee. Required by the API.
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
BIDSKETCH_POST_PROPOSAL_FEETool to create a proposal fee. Use after confirming the proposal exists to add a cost line item; require unit when feetype is custom.
Input parameters
Title of the fee line item
Unit label for calculated or custom fees. Required when feetype is 'custom'.
Base amount per unit or total amount for fixed fees.
Type of fee. Must be one of 'fixed', 'hourly', 'monthly', 'yearly', or 'custom'.
Whether the fee is optional. Defaults to false.
Quantity for calculated fees (e.g., hours).
HTML formatted description for the fee.
ID of the proposal to which this fee will be added
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
BIDSKETCH_POST_PROPOSAL_SECTIONTool to create a proposal section. Use after confirming a proposal exists to add a new opening or closing section.
Input parameters
Name/title of the section
HTML content of the section
ID of the proposal to which this section will be added
Section placement: 'opening' or 'closing'
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
BIDSKETCH_POST_SECTIONTool to create a section. Use when you need to add a new section to your account before including it in proposals.
Input parameters
The name of the section.
A section category to group sections together.
HTML-formatted content of the section. This field is required by the API.
Specifies where the section will appear in a proposal. Must be 'opening' or 'closing'.
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
BIDSKETCH_POST_WEBHOOKCreate a webhook subscription in Bidsketch to receive real-time notifications when specific events occur. Webhooks enable your application to receive immediate notifications when events happen in Bidsketch, such as when clients are created or proposals are sent, viewed, accepted, or declined. Your webhook endpoint must be publicly accessible and respond with HTTP 200 OK to webhook POST requests. Bidsketch will retry failed deliveries up to 20 times. Common use cases: - Sync client data to your CRM when a new client is created - Trigger workflows when proposals are sent or viewed - Update project management tools when proposals are accepted - Send notifications to your team when proposals are declined
Input parameters
Type of event to subscribe to. Supported values: 'client_created', 'proposal_created', 'proposal_sent', 'proposal_viewed', 'proposal_accepted', 'proposal_declined', or 'proposal_accepted_or_declined'.
Publicly accessible URL to receive webhook POST callbacks. Endpoint must respond with HTTP 200 OK or Bidsketch will retry delivery up to 20 times.
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
BIDSKETCH_PUT_CLIENTTool to update a client. Use when you need to modify existing client records with new data.
Input parameters
The unique identifier of the client to update.
City in the client's address.
Client's full name or company name.
Client's primary email address.
Notes about the client; quotes need not be escaped.
Client's primary phone number.
State in the client's address.
Country in the client's address.
Client's website.
Client's alternate phone number.
Client's last name if they are a person.
Client's first name if they are a person.
Postal or ZIP code of the client's address.
Secondary contact information for client update.
First line of the client's address.
Second line of the client's address.
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
BIDSKETCH_PUT_FEETool to update a fee. Use when you need to modify existing fee records with new data after verifying current values.
Input parameters
Name of the fee.
Unit label for custom fees. Required only when feetype is 'custom'.
Fee amount. For fixed fees, this is total; for calculated fees, this is per-unit amount.
Unique ID of the fee to update.
Type of fee. Must be one of 'fixed', 'hourly', 'monthly', 'yearly', or 'custom'.
A fee category to group fees together.
Quantity used for calculated fees.
HTML-formatted description of the fee.
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
BIDSKETCH_PUT_PROPOSALTool to update a specific proposal's details. Use after retrieving a proposal to apply changes.
Input parameters
The unique identifier of the proposal to update
Primary tax rate as a decimal percentage
Name/title of the proposal
Secondary tax rate as a decimal percentage
ISO 4217 currency code for the proposal
Discount rate as a decimal percentage
Nested settings for a proposal.
ID of the client associated with the proposal
Summary or description of the proposal
Date for the proposal (YYYY-MM-DD or datetime string)
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
BIDSKETCH_PUT_PROPOSAL_FEETool to update a proposal fee. Use when modifying specific properties of an existing fee within a proposal after verifying its existence.
Input parameters
New name/title for the fee line item
Unit label for custom fees; required when feetype is 'custom'
Updated amount or per-unit amount for the fee
ID of the specific fee to update within the proposal
Type of fee; one of 'fixed', 'hourly', 'monthly', 'yearly', or 'custom'.
Whether the fee is optional; leave blank to keep existing value
Updated quantity for calculated fees
Updated HTML description for the fee
ID of the proposal containing the fee to 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
BIDSKETCH_PUT_PROPOSAL_SECTIONTool to update a proposal section. Use when you need to modify the name or content of an existing section after verifying its existence.
Input parameters
New name/title for the section
ID of the specific section to update
New HTML content for the section
ID of the proposal containing the section to 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
BIDSKETCH_PUT_SECTIONTool to update a section. Use when you need to modify an existing section after confirming its ID.
Input parameters
The unique identifier of the section to update.
The name of the section.
A section category to group sections together.
HTML-formatted content of the section.
Specifies where the section will appear in a proposal. Must be 'opening' or 'closing'.
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 38 Bidsketch actions on Nagent, including "Create Client", "Create Proposal" and "Get Client". Create Client: Create a client. Each action is listed on this page with its input parameters and its output.
Bidsketch 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 Client takes 3 required inputs: email, last_name and first_name. It also takes 12 optional inputs: city, name, notes, phone, state, country, website, alt_phone, postal_zip, other_contact, address_field_one and address_field_two. It returns data, error and successful.