Crawl URL with FireCrawl API on New Outbound Message (Instant) from Salesforce API

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

Trigger workflow on

New Outbound Message (Instant) from the Salesforce API

Next, do this

Crawl URL with the FireCrawl 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#

This integration creates a workflow with a Salesforce trigger and FireCrawl action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Outbound Message (Instant) trigger
1. Connect your Salesforce account
2. Configure infoBox
Configure the Crawl URL action
1. Connect your FireCrawl account
2. Configure URL
3. Optional- Configure Includes
4. Optional- Configure Excludes
5. Optional- Configure Generate Image Alt Text
6. Optional- Configure Return Only URLs
7. Optional- Configure Max Depth
8. Optional- Select a Mode
9. Optional- Configure Ignore Sitemap
10. Optional- Configure Limit
11. Optional- Configure Allow Backward Crawling
12. Optional- Configure Allow External Content Links
13. Optional- Configure Headers
14. Optional- Configure Include HTML
15. Optional- Configure Include Raw HTML
16. Optional- Configure Only Include Tags
17. Optional- Configure Only Main Content
18. Optional- Configure Remove Tags
19. Optional- Configure Replace All Paths With Absolute Paths
20. Optional- Configure Screenshot
21. Optional- Configure Full Page Screenshot
22. Optional- Configure Wait For
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Outbound Message (Instant) on Salesforce

Description:Emit new event when a new outbound message is received in Salesforce.

Version:0.1.7

Key:salesforce_rest_api-new-outbound-message

View on GitHub

Salesforce Overview#

The Salesforce (REST API) provides a powerful platform for creating and managing customer relationships with a wide array of features like data manipulation, querying, and complex automation. With Pipedream's serverless execution, you can create workflows that automate your sales processes, sync data with other platforms, enhance customer engagement, and trigger actions based on specific events. Dive into Salesforce data, streamline lead management, track customer interactions, and push or pull data to or from Salesforce seamlessly.

Trigger Code#

import { XMLParser } from "fast-xml-parser";
import salesforce from "../../salesforce_rest_api.app.mjs";

export default {
  type: "source",
  name: "New Outbound Message (Instant)",
  key: "salesforce_rest_api-new-outbound-message",
  description: "Emit new event when a new outbound message is received in Salesforce.",
  version: "0.1.7",
  dedupe: "unique",
  props: {
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    salesforce,
    infoBox: {
      type: "alert",
      alertType: "info",
      content: `See Salesforce's guide on [setting up Outbound Messaging](https://sforce.co/3JbZJom).
\\
Set the Outbound Message's \`Endpoint URL\` to the endpoint of this source, which you can view after it is created.
\\
The \`Send Session ID\` option must be enabled in Salesforce for validating outbound messages.`,
    },
  },
  methods: {
    _unwrapMessage(message) {
      const parser = new XMLParser({
        removeNSPrefix: true,
      });
      const obj = parser.parse(message);
      const notifications = obj["Envelope"]["Body"].notifications;
      return notifications;
    },
    _sendHttpResponse(successValue = true, status) {
      // eslint-disable-next-line multiline-ternary
      status = status ?? (successValue ? 200 : 400);
      this.http.respond({
        status,
        body: `
          <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
          xmlns:out="http://soap.sforce.com/2005/09/outbound">
            <soapenv:Header/>
            <soapenv:Body>
              <out:notificationsResponse>
                <out:Ack>${successValue}</out:Ack>
              </out:notificationsResponse>
            </soapenv:Body>
          </soapenv:Envelope>
        `,
        headers: {
          "content-type": "text/xml",
        },
      });
    },
    async _isValidSessionId(sessionId) {
      try {
        const data = await this.salesforce.getUserInfo(sessionId);
        return Boolean(data);
      } catch (err) {
        console.log("Error validating SessionId:", err);
        return false;
      }
    },
    async _isValidSource(data) {
      const { SessionId: sessionId } = data;
      if (!sessionId) {
        throw new Error("The outbound message is missing a Session ID. Please configure the outbound message to send Session ID to validate the webhook source.");
      }

      return this._isValidSessionId(sessionId);
    },
    generateMeta(data) {
      const {
        ActionId: actionId,
        Notification: { Id: eventId },
      } = data;
      const id = `${eventId}-${actionId}`;
      const summary = JSON.stringify(data);
      const ts = Date.now();
      return {
        id,
        summary,
        ts,
      };
    },
  },
  async run(event) {
    const { bodyRaw } = event;
    this._sendHttpResponse(true);
    const data = this._unwrapMessage(bodyRaw);
    if (!(await this._isValidSource(data))) {
      console.log("Skipping event from unrecognized source");
      return;
    }

    let notifications = data.Notification;
    if (!Array.isArray(notifications)) {
      notifications = [
        data.Notification,
      ];
    }

    notifications.forEach((n) => {
      const notification = Object.assign(data, {
        Notification: n,
      });
      this.$emit(notification, this.generateMeta(notification));
    });
  },
};

Trigger 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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Salesforce	`salesforce`	`app`	This component uses the Salesforce app.

Trigger 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:

About Salesforce#

Web services API for interacting with Salesforce

Action#

Crawl URL on FireCrawl

Description:Crawls a given input URL and returns the contents of sub-pages. [See the documentation](https://docs.firecrawl.dev/api-reference/endpoint/crawl)

Version:0.0.1

Key:firecrawl-crawl-url

View on GitHub

Action Code#

import firecrawl from "../../firecrawl.app.mjs";

export default {
  key: "firecrawl-crawl-url",
  name: "Crawl URL",
  description: "Crawls a given input URL and returns the contents of sub-pages. [See the documentation](https://docs.firecrawl.dev/api-reference/endpoint/crawl)",
  version: "0.0.1",
  type: "action",
  props: {
    firecrawl,
    url: {
      propDefinition: [
        firecrawl,
        "url",
      ],
    },
    includes: {
      propDefinition: [
        firecrawl,
        "includes",
      ],
      optional: true,
    },
    excludes: {
      propDefinition: [
        firecrawl,
        "excludes",
      ],
      optional: true,
    },
    generateImgAltText: {
      propDefinition: [
        firecrawl,
        "generateImgAltText",
      ],
      optional: true,
    },
    returnOnlyUrls: {
      propDefinition: [
        firecrawl,
        "returnOnlyUrls",
      ],
      optional: true,
    },
    maxDepth: {
      propDefinition: [
        firecrawl,
        "maxDepth",
      ],
      optional: true,
    },
    mode: {
      propDefinition: [
        firecrawl,
        "mode",
      ],
      optional: true,
    },
    ignoreSitemap: {
      propDefinition: [
        firecrawl,
        "ignoreSitemap",
      ],
      optional: true,
    },
    limit: {
      propDefinition: [
        firecrawl,
        "limit",
      ],
      optional: true,
    },
    allowBackwardCrawling: {
      propDefinition: [
        firecrawl,
        "allowBackwardCrawling",
      ],
      optional: true,
    },
    allowExternalContentLinks: {
      propDefinition: [
        firecrawl,
        "allowExternalContentLinks",
      ],
      optional: true,
    },
    headers: {
      propDefinition: [
        firecrawl,
        "headers",
      ],
      optional: true,
    },
    includeHtml: {
      propDefinition: [
        firecrawl,
        "includeHtml",
      ],
      optional: true,
    },
    includeRawHtml: {
      propDefinition: [
        firecrawl,
        "includeRawHtml",
      ],
      optional: true,
    },
    onlyIncludeTags: {
      propDefinition: [
        firecrawl,
        "onlyIncludeTags",
      ],
      optional: true,
    },
    onlyMainContent: {
      propDefinition: [
        firecrawl,
        "onlyMainContent",
      ],
      optional: true,
    },
    removeTags: {
      propDefinition: [
        firecrawl,
        "removeTags",
      ],
      optional: true,
    },
    replaceAllPathsWithAbsolutePaths: {
      propDefinition: [
        firecrawl,
        "replaceAllPathsWithAbsolutePaths",
      ],
      optional: true,
    },
    screenshot: {
      propDefinition: [
        firecrawl,
        "screenshot",
      ],
      optional: true,
    },
    fullPageScreenshot: {
      propDefinition: [
        firecrawl,
        "fullPageScreenshot",
      ],
      optional: true,
    },
    waitFor: {
      propDefinition: [
        firecrawl,
        "waitFor",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.firecrawl.crawl({
      $,
      data: {
        url: this.url,
        crawlerOptions: {
          includes: this.includes,
          excludes: this.excludes,
          generateImgAltText: this.generateImgAltText,
          returnOnlyUrls: this.returnOnlyUrls,
          maxDepth: parseInt(this.maxDepth),
          mode: this.mode,
          ignoreSitemap: this.ignoreSitemap,
          limit: this.limit,
          allowBackwardCrawling: this.allowBackwardCrawling,
          allowExternalContentLinks: this.allowExternalContentLinks,
        },
        pageOptions: {
          headers: this.headers,
          includeHtml: this.includeHtml,
          includeRawHtml: this.includeRawHtml,
          onlyIncludeTags: this.onlyIncludeTags,
          onlyMainContent: this.onlyMainContent,
          removeTags: this.removeTags,
          replaceAllPathsWithAbsolutePaths: this.replaceAllPathsWithAbsolutePaths,
          screenshot: this.screenshot,
          fullPageScreenshot: this.fullPageScreenshot,
          waitFor: parseInt(this.waitFor),
        },
      },
    });

    $.export("$summary", `Crawl job started with jobId: ${response.jobId}`);
    return response;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
FireCrawl	`firecrawl`	`app`	This component uses the FireCrawl app.
URL	`url`	`string`	The URL to start crawling from.
Includes	`includes`	`string[]`	URL patterns to include.
Excludes	`excludes`	`string[]`	URL patterns to exclude.
Generate Image Alt Text	`generateImgAltText`	`boolean`	Generate alt text for images using LLMs (must have a paid plan).
Return Only URLs	`returnOnlyUrls`	`boolean`	If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.
Max Depth	`maxDepth`	`string`	Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern.
Mode	`mode`	`string`	Select a value from the drop down menu:`defaultfast`
Ignore Sitemap	`ignoreSitemap`	`boolean`	Ignore the website sitemap when crawling.
Limit	`limit`	`integer`	Maximum number of pages to crawl.
Allow Backward Crawling	`allowBackwardCrawling`	`boolean`	Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'.
Allow External Content Links	`allowExternalContentLinks`	`boolean`	Allows the crawler to follow links to external websites.
Headers	`headers`	`object`	Headers to send with the request. Can be used to send cookies, user-agent, etc..
Include HTML	`includeHtml`	`boolean`	Include the HTML version of the content on page.
Include Raw HTML	`includeRawHtml`	`boolean`	Include the raw HTML content of the page.
Only Include Tags	`onlyIncludeTags`	`string[]`	Only include tags, classes, and ids from the page in the final output. Example: 'script, .ad, #footer'.
Only Main Content	`onlyMainContent`	`boolean`	Only return the main content of the page excluding headers, navs, footers, etc..
Remove Tags	`removeTags`	`string[]`	Tags, classes, and ids to remove from the page. Example: 'script, .ad, #footer'.
Replace All Paths With Absolute Paths	`replaceAllPathsWithAbsolutePaths`	`boolean`	Replace all relative paths with absolute paths for images and links.
Screenshot	`screenshot`	`boolean`	Include a screenshot of the top of the page that you are scraping.
Full Page Screenshot	`fullPageScreenshot`	`boolean`	Include a full page screenshot of the page that you are scraping.
Wait For	`waitFor`	`string`	Wait x amount of milliseconds for the page to load to fetch content.

Action Authentication#

FireCrawl uses API keys for authentication. When you connect your FireCrawl account, Pipedream securely stores the keys so you can easily authenticate to FireCrawl APIs in both code and no-code steps.