Close

Create leads, log activities, and manage your sales pipeline in Close.

CRM and salesAPI key6 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (6)
create_lead
find_lead
create_contact
create_opportunity
custom_api_call
find_contact
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("close", "create_lead", {
    "name": "<lead name>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Close answered", { output: res.output });
}

defineWorkflow module

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

export default defineWorkflow({
  id: "close-create-lead",
  name: "Close: Create Lead",
  description: "Calls Close when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("close", {
      "action": "create_lead",
      "name": "<lead name>"
    }) 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/close/create_lead" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"name":"<lead name>"}}'

Actions

create_leadin catalog

Create Lead. Creates a new lead.

Input	Type	Description
`name`required	text	The name of the lead/company.
`url`optional	text	URL
`description`optional	long text	Description
`contacts`optional	array	Array of contact details for this lead
`statusId`optional	id (picked from your account)	Status
`customFields`optional	object (depends on other props)	Custom Fields

find_leadin catalog

Find Lead. Search for leads with advanced filtering options

Input	Type	Description
`search_type`required	one of "name" \| "contact_email" \| "status"	Search Type
`search_query`required	text	Search Query
`match_type`optional	one of "contains" \| "exact" \| "starts" \| "ends"	Match Type

create_contact

Create Contact. Creates a new contact.

Input	Type	Description
`lead_id`optional	id (picked from your account)	Lead
`name`required	text	Name
`title`optional	text	Title
`officePhone`optional	text	Office Phone
`mobilePhone`optional	text	Mobile Phone
`homePhone`optional	text	Home Phone
`directPhone`optional	text	Direct Phone
`faxPhone`optional	text	Fax Phone
`otherPhone`optional	text	Other Phone
`officeEmail`optional	text	Office Email
`homeEmail`optional	text	Home Email
`directEmail`optional	text	Direct Email
`otherEmail`optional	text	Other Email
`url`optional	text	URL
`customFields`optional	object (depends on other props)	Custom Fields

create_opportunity

Create Opportunity. Create a new opportunity.

Input	Type	Description
`lead_id`optional	id (picked from your account)	Lead
`status_id`required	id (picked from your account)	Status
`name`optional	text	A descriptive name for the opportunity.
`note`optional	long text	Additional details about the opportunity.
`confidence`optional	number	The probability of winning this opportunity (0-100).
`value`optional	number	Value
`value_period`optional	one of "one_time" \| "monthly" \| "annual"	The period for the opportunity value.
`contact_id`optional	text	The ID of the contact associated with this opportunity.
`user_id`optional	id (picked from your account)	User
`custom_fields`optional	object (depends on other props)	Custom Fields

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

find_contact

Find Contact. Search for contacts by name, email, or other criteria with advanced filtering

Input	Type	Description
`search_type`required	one of "name" \| "email" \| "phone" \| "lead_id"	Search Type
`search_query`required	text	Search Query
`match_type`optional	one of "contains" \| "exact" \| "starts" \| "ends"	Match Type

Details

Id: close
Category: CRM and sales
Tags: crm, sales, leads, pipeline, calling
Package: @activepieces/piece-close@0.1.4
Tier: Community