Salesforce Integration

Field	Description	Required	Format
Client ID	Connected App consumer key	Yes	`-`
Client Secret	Connected App consumer secret	Yes	`-`

Field	Description	Required	Format
Access Token / Session ID	Salesforce access token or session ID	Yes	`-`
Instance URL	Your Salesforce instance URL (e.g. https://your-org.my.salesforce.com)	Yes	`https://your-org.my.salesforce.com`

soql_query — Execute a SOQL query (Salesforce Object Query Language)

Parameters

query

string

required

SOQL query (e.g. ‘SELECT Id, Name FROM Account LIMIT 10’)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "total_size": {
      "default": 0,
      "title": "Total Size",
      "type": "integer"
    },
    "done": {
      "default": true,
      "title": "Done",
      "type": "boolean"
    },
    "next_records_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Next Records Url"
    },
    "records": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Records",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "SoqlQueryOutput",
  "type": "object"
}

sosl_search — Execute a SOSL cross-object search

Parameters

string

required

SOSL search (e.g. ‘FIND {test} IN ALL FIELDS RETURNING Account(Id, Name)‘)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "search_records": {
      "default": null,
      "title": "Search Records"
    }
  },
  "required": [
    "success"
  ],
  "title": "SoslSearchOutput",
  "type": "object"
}

get_record — Get a record by object type + ID

Parameters

object_type

string

required

Salesforce object type (e.g. Account, Contact, Lead)

record_id

string

required

Salesforce record ID

fields

array

Specific fields to return (all if omitted)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetRecordOutput",
  "type": "object"
}

create_record — Generic create — works for any object type

Parameters

object_type

string

required

Salesforce object type (e.g. Account, Contact, Lead)

data

object

required

Record data as key-value pairs

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "object_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Object Type"
    },
    "created": {
      "default": true,
      "title": "Created",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateRecordOutput",
  "type": "object"
}

update_record — PATCH an existing record

Parameters

object_type

string

required

Salesforce object type (e.g. Account, Contact, Lead)

record_id

string

required

Salesforce record ID

data

object

required

Updated fields

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "object_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Object Type"
    },
    "updated": {
      "default": false,
      "title": "Updated",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateRecordOutput",
  "type": "object"
}

delete_record — DELETE a record by object type + ID

Parameters

object_type

string

required

Salesforce object type (e.g. Account, Contact, Lead)

record_id

string

required

Salesforce record ID

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "object_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Object Type"
    },
    "deleted": {
      "default": false,
      "title": "Deleted",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteRecordOutput",
  "type": "object"
}

create_account — Create an Account record

Parameters

name

string

required

Account name

description

string

Description

website

string

Website URL

phone

string

Phone number

industry

string

Industry

annual_revenue

number

Annual revenue

number_of_employees

integer

Number of employees

billing_street

string

Billing street

billing_city

string

Billing city

billing_state

string

Billing state/province

billing_postal_code

string

Billing postal code

billing_country

string

Billing country

additional_fields

object

Additional custom fields

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "created": {
      "default": true,
      "title": "Created",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateAccountOutput",
  "type": "object"
}

create_contact — Create a Contact record

Parameters

last_name

string

required

Last name (required)

first_name

string

First name

account_id

string

Linked Account ID

string

Email address

phone

string

Phone number

mobile_phone

string

Mobile phone

title

string

Job title

department

string

Department

mailing_street

string

Mailing street

mailing_city

string

Mailing city

mailing_state

string

Mailing state

mailing_postal_code

string

Mailing postal code

mailing_country

string

Mailing country

additional_fields

object

Additional custom fields

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "last_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Last Name"
    },
    "created": {
      "default": true,
      "title": "Created",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateContactOutput",
  "type": "object"
}

create_lead — Create a Lead record

Parameters

last_name

string

required

Last name

company

string

required

Company

first_name

string

First name

string

phone

string

Phone

title

string

Title

status

string

Status

rating

string

Rating

industry

string

Industry

annual_revenue

number

Annual revenue

lead_source

string

Lead source

additional_fields

object

Additional custom fields

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "last_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Last Name"
    },
    "company": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Company"
    },
    "created": {
      "default": true,
      "title": "Created",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateLeadOutput",
  "type": "object"
}

create_opportunity — Create an Opportunity record

Parameters

name

string

required

Opportunity name

stage_name

string

required

Stage

close_date

string

required

Expected close date (YYYY-MM-DD)

account_id

string

Account ID

amount

number

Amount

probability

integer

Probability % (0-100)

type

string

Type

lead_source

string

Lead source

description

string

Description

additional_fields

object

Additional custom fields

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "created": {
      "default": true,
      "title": "Created",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateOpportunityOutput",
  "type": "object"
}

create_task — Create a Task record

Parameters

subject

string

required

Task subject

status

string

Status (Not Started / In Progress / Completed / etc.) (Default: Not Started)

priority

string

Priority (Default: Normal)

activity_date

string

Due date (YYYY-MM-DD)

what_id

string

Related object ID (Account/Opportunity/etc.)

who_id

string

Related Lead/Contact ID

description

string

Description

additional_fields

object

Additional custom fields

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "subject": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Subject"
    },
    "created": {
      "default": true,
      "title": "Created",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateTaskOutput",
  "type": "object"
}

create_case — Create a Case record (support ticket)

Parameters

subject

string

required

Case subject

status

string

Status (Default: New)

priority

string

Priority (Default: Medium)

origin

string

Origin (Email/Phone/Web/…)

account_id

string

Linked Account ID

contact_id

string

Linked Contact ID

description

string

Description

type

string

Case type

reason

string

Case reason

additional_fields

object

Additional custom fields

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "subject": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Subject"
    },
    "created": {
      "default": true,
      "title": "Created",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateCaseOutput",
  "type": "object"
}

add_contact_to_campaign — Create a CampaignMember linking a Contact to a Campaign

Parameters

campaign_id

string

required

Campaign ID

contact_id

string

required

Contact ID

status

string

Member status

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "campaign_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Campaign Id"
    },
    "contact_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Contact Id"
    },
    "created": {
      "default": true,
      "title": "Created",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "AddContactToCampaignOutput",
  "type": "object"
}

add_lead_to_campaign — Create a CampaignMember linking a Lead to a Campaign

Parameters

campaign_id

string

required

Campaign ID

lead_id

string

required

Lead ID

status

string

Member status

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "campaign_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Campaign Id"
    },
    "lead_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Lead Id"
    },
    "created": {
      "default": true,
      "title": "Created",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "AddLeadToCampaignOutput",
  "type": "object"
}

describe_object — Describe an object type's fields + capabilities

Parameters

object_type

string

required

Salesforce object type (e.g. Account, Contact, Lead)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "label": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Label"
    },
    "key_prefix": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Key Prefix"
    },
    "createable": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Createable"
    },
    "updateable": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Updateable"
    },
    "deletable": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Deletable"
    },
    "queryable": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Queryable"
    },
    "searchable": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Searchable"
    },
    "fields": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Fields",
      "type": "array"
    },
    "field_count": {
      "default": 0,
      "title": "Field Count",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "DescribeObjectOutput",
  "type": "object"
}

list_objects — List all queryable Salesforce objects in the org

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "objects": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Objects",
      "type": "array"
    },
    "total_count": {
      "default": 0,
      "title": "Total Count",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListObjectsOutput",
  "type": "object"
}

​Overview

​Authentication

​OAuth 2.0 (Connected App)

​Required Credentials

​OAuth Configuration

​Session ID / Access Token

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Response

​Related integrations

Clay

Dropcontact

HubSpot

​Links

Overview

Authentication

OAuth 2.0 (Connected App)

Required Credentials

OAuth Configuration

Session ID / Access Token

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Related integrations

Links