SOSL Search (Object Search) with Salesforce API

Pipedream makes it easy to connect APIs for Salesforce and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

SOSL Search (Object Search) with the Salesforce API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to SOSL Search (Object Search) with the Salesforce API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the SOSL Search (Object Search) action
1. Connect your Salesforce account
2. Configure docsInfo
3. Configure exampleInfo
4. Configure SOSL Query
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

SOSL Search with Salesforce API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Salesforce

Try it

SOSL Search with Salesforce API on New Message (Instant) from Discord API

Discord + Salesforce

Try it

SOSL Search with Salesforce API on New Message In Channels (Instant) from Slack API

Slack + Salesforce

Try it

SOSL Search with Salesforce API on New Message in Channel from Discord Bot API

Discord Bot + Salesforce

Try it

SOSL Search with Salesforce API on New Submission from Typeform API

Typeform + Salesforce

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

SOSL Search (Object Search) on Salesforce

Description:Executes a [Salesforce Object Search Language (SOSL)](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_sosl_examples.htm) text-based search query.

Version:0.2.8

Key:salesforce_rest_api-sosl-search

View on GitHub

Code#

import salesforce from "../../salesforce_rest_api.app.mjs";

const docsLink = "https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_sosl_examples.htm";

export const docsInfo = {
  type: "alert",
  alertType: "info",
  content: "You can find helpful information on SOQL and SOSL in [the Salesforce documentation](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_sosl_intro.htm).",
};

export default {
  key: "salesforce_rest_api-sosl-search",
  name: "SOSL Search (Object Search)",
  description: `Executes a [Salesforce Object Search Language (SOSL)](${docsLink}) text-based search query.`,
  version: "0.2.8",
  type: "action",
  props: {
    salesforce,
    docsInfo,
    exampleInfo: {
      type: "alert",
      alertType: "info",
      content: "Example search: `FIND {Joe Smith} IN Name Fields RETURNING lead(name, phone)`",
    },
    search: {
      type: "string",
      label: "SOSL Query",
      description: `A SOSL search query. [See the documentation](${docsLink}) for examples and more information.`,
    },
  },
  async run({ $ }) {
    const response = await this.salesforce.search({
      $,
      search: this.search,
    });
    $.export("$summary", `Successfully returned ${response.searchRecords?.length} results for SOSL search`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Salesforce	`salesforce`	`app`	This component uses the Salesforce app.
SOSL Query	`search`	`string`	A SOSL search query. See the documentation for examples and more information.

Authentication#

Salesforce uses OAuth authentication. When you connect your Salesforce account, Pipedream will open a popup window where you can sign into Salesforce and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Salesforce API.

Pipedream requests the following authorization scopes when you connect your account: