Skip to main content
Insightly
Previewv2.0.0
74 actions · 2 events · 1 auth method
CRM

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

Uses HTTP Basic auth with the personal API key as the username and an empty password. The pod (e.g. na1, eu1) is part of…
Optionally, configure receiving Events for Insightly into StackOne.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

74 actions
Action
Description
Get Contacts
Returns a paginated list of contacts.
Get Contacts (Filtered)
Searches contacts by a single field name and value.
Get Contact
Returns full details of a single contact by RECORD_ID.
Add Contact
Creates a new contact in Insightly.
Update Contact
Updates an existing contact. CONTACT_ID in body identifies which contact.
Delete Contact
Permanently deletes a contact by RECORD_ID.
Get Countries
Returns the static list of countries used by Insightly addresses.
Get Currencies
Returns the static list of currencies supported by Insightly.
Get Custom Fields
Returns the custom-field metadata defined on the tenant for one object type, including each field’s FIELD_NAME.
Get Emails
Returns a paginated list of email records, including each EMAIL_ID.
Get Events
Returns a paginated list of calendar events. Use top/skip for offset pagination, brief for lightweight payloads, and upd…
Get Event
Returns full details of a single calendar event by EVENT_ID.
Add Event
Creates a new calendar event in Insightly. START_DATE_UTC and END_DATE_UTC are required.
Update Event
Updates an existing calendar event. EVENT_ID is sent in the body and identifies the record to update.
Delete Event
Deletes a calendar event by EVENT_ID. Returns 202 Accepted on success.
Get Lead Sources
Returns all lead source definitions configured in the Insightly tenant.
Add Lead Source
Creates a new lead source definition in the Insightly tenant.
Get Lead Statuses
Returns all lead status definitions configured in the Insightly tenant.
Add Lead Status
Creates a new lead status definition in the Insightly tenant.
Get Leads
Returns a paginated list of leads.
Get Leads (Filtered)
Searches leads by a single field name and value.
Get Lead
Returns full details of a single lead by RECORD_ID.
Add Lead
Creates a new lead in Insightly. LAST_NAME, LEAD_STATUS_ID, and LEAD_SOURCE_ID are required.
Update Lead
Updates an existing lead. LEAD_ID in body identifies which lead.
Delete Lead
Permanently deletes a lead by RECORD_ID.
Get Milestones
Returns project milestones, each with its MILESTONE_ID.
Get Notes
Returns a paginated list of notes. Use top/skip for offset pagination, brief for lightweight payloads, and updated_after…
Get Note
Returns full details of a single note by NOTE_ID.
Add Note
Creates a new note in Insightly, attached to a parent record (Contact, Lead, Opportunity, Organisation, or Project).
Update Note
Updates an existing note. NOTE_ID is sent in the body and identifies the record to update.
Delete Note
Deletes a note by NOTE_ID. Returns 202 Accepted on success.
Get Opportunities
Returns a paginated list of opportunities.
Get Opportunities (Filtered)
Searches opportunities by a single field name and value.
Get Opportunity
Returns full details of a single opportunity by RECORD_ID.
Add Opportunity
Creates a new opportunity in Insightly.
Update Opportunity
Updates an existing opportunity. OPPORTUNITY_ID in body identifies which opportunity.
Delete Opportunity
Permanently deletes an opportunity by RECORD_ID.
Get Opportunity Categories
Returns the opportunity categories configured in the tenant, each with its CATEGORY_ID.
Get Organisations
Returns a paginated list of organisations.
Get Organisations (Filtered)
Searches organisations by a single field name and value.
Get Organisation
Returns full details of a single organisation by RECORD_ID.
Add Organisation
Creates a new organisation in Insightly.
Update Organisation
Updates an existing organisation. ORGANISATION_ID in body identifies which organisation.
Delete Organisation
Permanently deletes an organisation by RECORD_ID.
Get Pipeline Stages
Returns a paginated list of pipeline stages.
Get Pipeline Stage
Returns full details of a pipeline stage by STAGE_ID.
Get Pipelines
Returns a paginated list of pipelines.
Get Pipeline
Returns full details of a pipeline by PIPELINE_ID.
Get Products
Use this for unfiltered browsing of products. For exact-match filtering by a specific field value, use get_products_filt…
Get Products (Filtered)
Search products by a specific field name and value with offset pagination.
Get Product
Returns full details of a single product by PRODUCT_ID.
Add Product
Creates a new product in Insightly. PRODUCT_NAME, DEFAULT_PRICE, and ACTIVE are required; provide other fields as needed…
Update Product
Updates an existing product. PRODUCT_ID in body identifies which product.
Delete Product
Permanently deletes a product by PRODUCT_ID.
Get Projects
Returns a paginated list of projects. Use top/skip for offset pagination, brief for lightweight payloads, and updated_af…
Get Projects (Filtered)
Search projects by a specific field name and value with offset pagination.
Get Project
Returns full details of a single project by PROJECT_ID.
Add Project
Creates a new project in Insightly. PROJECT_NAME and STATUS are required; provide other fields as needed.
Update Project
Updates an existing project. PROJECT_ID is sent in the body and identifies the record to update.
Delete Project
Deletes a project by PROJECT_ID. Returns 202 Accepted on success.
Get Project Categories
Returns the project categories configured in the tenant, each with its CATEGORY_ID.
Get Tags
Returns the tags attached to one specific Insightly record. Insightly also exposes an account-wide GET /Tags listing, wh…
Get Tasks
Returns a paginated list of tasks. Use top/skip for offset pagination, brief for lightweight payloads, and updated_after…
Get Tasks (Filtered)
Search tasks by a specific field name and value with offset pagination.
Get Task
Returns full details of a single task by TASK_ID.
Add Task
Creates a new task in Insightly. TITLE, COMPLETED, and OWNER_USER_ID are required; provide other fields as needed.
Update Task
Updates an existing task. TASK_ID is sent in the body and identifies the record to update.
Delete Task
Deletes a task by TASK_ID. Returns 202 Accepted on success.
Get Task Categories
Returns the task categories configured in the tenant, each with its CATEGORY_ID.
Get Teams
Returns a paginated list of teams, including each team’s TEAM_ID.
Add Team
Creates a team and returns its server-minted TEAM_ID.
Get Users
Returns a paginated list of users in the Insightly instance.
Get User
Returns full details of a user by USER_ID.
Get Current User
Returns the authenticated user’s record.

Events

|
2 events
Event
Description
Tags
Active Check
Responds to a manual connectivity test when the webhook URL is called with ?event=ping or with no request body. Insigh…
Health Check
Insightly Webhook
Processes inbound Insightly Workflow Automation webhook events.
Webhooks