Insightly
Arcade.dev tools for interacting with Insightly
0.1.0Arcade tools for Insightly, a CRM platform. This toolkit enables reading, creating, updating, and querying Insightly records—contacts, leads, organizations, opportunities, projects, tasks, notes, and pipelines—via Arcade-hosted tools.
Capabilities
- Record CRUD — Create and update the core CRM objects: contacts, leads, organizations, opportunities, projects, and tasks. Each save tool doubles as a create (omit the ID) or update (supply the ID).
- Search and lookup — Search any object type by name, email, status, pipeline, domain, due date, or related record; retrieve single records by ID for any object type.
- Activity and context gathering — Fetch a record's recent notes, open tasks, deal stage, and linked account/project in a single call to prepare for calls or account briefings without chaining multiple queries.
- Pipeline and forecast views — List pipelines, list stages in defined order, and roll up opportunities by stage with counts and summed values for pipeline forecasting.
- Lead conversion — Convert a qualified lead into a contact, organization, and optional opportunity in one operation, carrying over all relevant fields.
- Account and user metadata — Identify the authenticated user, list all account users, and look up configured lead statuses, sources, and pipeline definitions for mapping natural-language values to IDs.
Secrets
INSIGHTLY_API_KEY
Your Insightly REST API key, used to authenticate every request. Retrieve it from the Insightly web app: go to User Menu → User Settings → API Key (the key is shown at the bottom of the page). All Insightly plans include API access; no special tier is required. See Insightly API authentication docs for details.
INSIGHTLY_API_URL
The base URL for your Insightly API endpoint (e.g., https://api.insightly.com/v3.1). Insightly uses a single global endpoint for most accounts, but verify the correct URL in your Insightly plan or API documentation if you are on a regional or private instance. This lets the toolkit route requests to the right host without hardcoding.
Store both secrets in Arcade using the secrets guide, or manage them directly at https://api.arcade.dev/dashboard/auth/secrets.
Available tools(29)
| Tool name | Description | Secrets | |
|---|---|---|---|
Convert a qualified lead into a contact (when the lead names a person), an organization
(when the lead names one), and optionally an opportunity, then mark the lead converted.
The lead's name, email, phone, and title carry onto the contact, and its name/phone/website
onto the organization. A lead with only a last name becomes a contact under that name, since
Insightly stores a single-name person in the contact's first-name field. Insightly leaves the
lead's notes on the lead, so by default they are copied onto the new contact (or organization).
Fails if the lead has already been converted. Conversion is several creates followed by the
final lead update; it is not idempotent, so if a later step fails the lead stays unconverted
and any records already created remain. Check the lead in Insightly before retrying a failed
conversion so a retry does not duplicate records. | 2 | ||
Log a note against one CRM record. Provide exactly one record id to attach it to. | 2 | ||
Retrieve a single contact by its identifier. | 2 | ||
Return the identity of the authenticated Insightly user (the "who am I" for this account).
Call this first to confirm who actions will be attributed to. | 2 | ||
Retrieve a single lead by its identifier. | 2 | ||
Roll up one user's open deals and open tasks in a single call.
Defaults to the caller (the authenticated user), so "what's on my plate" is one read instead
of a separate pipeline summary and task search. The summed open-deal value covers every
matched deal, not just the returned window. | 2 | ||
Retrieve a single opportunity by its identifier. | 2 | ||
Retrieve a single organization by its identifier. | 2 | ||
Retrieve a single project by its identifier. | 2 | ||
Gather one record's recent notes and open tasks in one call, plus the deal stage.
Provide exactly one record id. Use this single call to prepare for a call or recap an
account instead of running separate note and task searches. When the record is an
opportunity, the response also carries that deal's current stage, state, and value; when
it is a project, it carries the project's parent opportunity and that deal's organization
so a delivery kickoff brief is one read; when it is a contact or organization, the response
also carries the opportunities and delivery projects that touch the account. | 2 | ||
Retrieve a single task by its identifier. | 2 | ||
List the account's configured lead statuses and lead sources so a natural-language
status or source name maps to the id that save_lead expects. | 2 | ||
List the configured pipelines, optionally filtered to opportunity or project pipelines. | 2 | ||
List a pipeline's stages in their defined order, so stage moves target real stages. | 2 | ||
List the users in the account, for attributing and assigning records. | 2 | ||
Create or update a contact. Omit contact_id to create (a first or last name is required). | 2 | ||
Create or update a lead. Omit lead_id to create a new lead (supply a last name, an
organization name, or both). | 2 | ||
Create or update an opportunity, including advancing its stage and recording won/lost.
Omit opportunity_id to create (a name is required). A new opportunity created without a
pipeline_id and stage_id is left unplaced: it still rolls up in the forecast under the
"(no stage)" bucket but cannot advance through a stage-based pipeline, so set pipeline_id
and stage_id together when you know the deal's pipeline and stage. | 2 | ||
Create or update an organization. Omit organization_id to create (a name is required). | 2 | ||
Create or update a delivery project, including advancing its stage.
Omit project_id to create (a name is required). | 2 | ||
Create or update a task, optionally linked to a deal, project, contact, or org.
Omit task_id to create (a title is required). | 2 | ||
Find contacts by name, email, or organization. Returns the account's default order. | 2 | ||
Find leads by name, email, conversion state, or status. Returns the account's default
order. | 2 | ||
Read notes most recently created first within the scanned window, account-wide or for one
record.
Omit every record id for an account-wide activity feed (combine owner_user_id and the
created_after / created_before window for a standup-style recap), or provide exactly one
record id to read the notes on that single record. Date bounds are inclusive.
Notes are gathered by scanning the collection up to a ceiling and ordering that scanned set
most-recently-created first; when scan_truncated is true the scan stopped before reaching the
whole collection, so the newest notes may lie beyond the scanned window. Narrow with a record
id, owner, or a created_after / created_before window to bring the result within that window. | 2 | ||
Find opportunities by name, state, pipeline, or organization. Returns the default order. | 2 |