Freshsales

Create contacts, manage deals, and track your sales in Freshsales.

CRM and salesAPI key2 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (2)
freshsales_create_contact
custom_api_call
Details

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.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("freshsales", "freshsales_create_contact", {
    "email": "<email>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Freshsales answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "freshsales-freshsales-create-contact",
  name: "Freshsales: Create Contact",
  description: "Calls Freshsales when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("freshsales", {
      "action": "freshsales_create_contact",
      "email": "<email>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/freshsales/freshsales_create_contact" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"email":"<email>"}}'

Actions

freshsales_create_contactin catalog

Create Contact. Add new contact in Freshsales CRM

Also accepted as create_contact.

Input	Type	Description
`first_name`optional	text	First name of the contact
`last_name`optional	text	Last name of the contact
`job_title`optional	text	Designation of the contact in the account they belong to
`email`required	text	Primary email address of the contact
`work_number`optional	text	Work phone number of the contact
`mobile_number`optional	text	Mobile phone number of the contact
`address`optional	text	Address of the contact
`city`optional	text	City that the contact belongs to
`state`optional	text	State that the contact belongs to
`zipcode`optional	text	Zipcode of the region that the contact belongs to
`country`optional	text	Country that the contact belongs to
`territory_id`optional	text	ID of the territory that the contact belongs to
`owner_id`optional	text	ID of the user to whom the contact has been assigned
`subscription_status`optional	text	Status of subscription that the contact is in.
`medium`optional	text	The medium that led your contact to your website/web app
`campaign_id`optional	text	The campaign that led your contact to your web app.
`keyword`optional	text	The keywords that the contact used to reach your website/web app
`time_zone`optional	text	Timezone that the contact belongs to
`facebook`optional	text	Facebook username of the contact
`twitter`optional	text	Twitter username of the contact

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

Details

Id: freshsales
Category: CRM and sales
Tags: crm, sales, contacts, deals, freshworks
Package: @activepieces/piece-freshsales@0.4.4
Tier: Community