Insightly
Create and list contacts in Insightly CRM.
On this page
Connect
Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.
- In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
- For every project in a workspace: Workspace settings, Integrations.
- Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.
Call it from a workflow
Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.
// .workflow.js (native ctx)
export async function run(ctx) {
const res = await ctx.integrations.invoke("insightly", "create_record", {
"pod": "<pod>",
"objectName": "Contacts",
"fields": {}
});
if (!res.success) throw new Error(res.error);
ctx.log.info("Insightly answered", { output: res.output });
}// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";
export default defineWorkflow({
id: "insightly-create-record",
name: "Insightly: Create Record",
description: "Calls Insightly when a row is created.",
trigger: { type: "entity_event", entity: "tickets", event: "created" },
async run(ctx, event) {
const res = await ctx.integrations.call("insightly", {
"action": "create_record",
"pod": "<pod>",
"objectName": "Contacts",
"fields": {}
}) as { success: boolean; error?: string };
if (!res.success) throw new Error(res.error);
},
});curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/insightly/create_record" \
-H "Authorization: Bearer $APP_KEY" \
-H "content-type: application/json" \
-d '{"props":{"pod":"<pod>","objectName":"Contacts","fields":{}}}'Actions
create_recordin catalog
Create Record. Create a new record in a specified Insightly object (Contact, Lead, Opportunity, etc.)
| Input | Type | Description |
|---|---|---|
podrequired | text | Your Insightly pod (e.g., "na1", "eu1"). Find this in your API URL: https://api.{pod}.insightly.com |
objectNamerequired | one of "Contacts" | "Leads" | "Opportunities" | "Organisations" | "Projects" | "Tasks" | "Events" | "Products" | "Quotations" | Select the type of record to create |
fieldsrequired | object (depends on other props) | Fields |
delete_recordin catalog
Delete Record. Delete a record by ID from a specified Insightly object
| Input | Type | Description |
|---|---|---|
podrequired | text | Your Insightly pod (e.g., "na1", "eu1"). Find this in your API URL: https://api.{pod}.insightly.com |
objectNamerequired | one of "Contacts" | "Leads" | "Opportunities" | "Organisations" | "Projects" | "Tasks" | "Events" | "Products" | "Quotations" | Select the type of record to delete |
recordIdrequired | id (picked from your account) | Select the record to delete |
find_recordsin catalog
Find Records. Find records in a specified Insightly object
| Input | Type | Description |
|---|---|---|
podrequired | text | Your Insightly pod (e.g., "na1", "eu1"). |
objectNamerequired | one of "Contacts" | "Leads" | "Opportunities" | "Organisations" | "Projects" | "Tasks" | "Events" | "Products" | "Quotations" | Select the type of records to find |
fieldNamerequired | id (picked from your account) | Select the field to search by |
fieldValuerequired | text | The value to search for |
topoptional | number | Maximum number of records to return |
get_recordin catalog
Get Record. Get a record by ID from a specified Insightly object
| Input | Type | Description |
|---|---|---|
podrequired | text | Your Insightly pod (e.g., "na1", "eu1"). Find this in your API URL: https://api.{pod}.insightly.com |
objectNamerequired | one of "Contacts" | "Leads" | "Opportunities" | "Organisations" | "Projects" | "Tasks" | "Events" | "Products" | "Quotations" | Select the type of record to retrieve |
recordIdrequired | id (picked from your account) | Select the record to retrieve |
update_recordin catalog
Update Record. Update an existing record's fields in a specified Insightly object
| Input | Type | Description |
|---|---|---|
podrequired | text | Your Insightly pod (e.g., "na1", "eu1"). Find this in your API URL: https://api.{pod}.insightly.com |
objectNamerequired | one of "Contacts" | "Leads" | "Opportunities" | "Organisations" | "Projects" | "Tasks" | "Events" | "Products" | "Quotations" | Select the type of object that contains the record you want to update |
recordIdrequired | id (picked from your account) | Select the record to update |
fieldsrequired | object (depends on other props) | The new field values to update. |
Details
- Id
insightly- Category
- CRM and sales
- Tags
- crm, contacts, projects, small-business
- Package
@activepieces/piece-insightly@0.1.3- Tier
- Community