Add Request to Queue with fal.ai API on New Outbound Message (Instant) from Salesforce API

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

Trigger workflow on

New Outbound Message (Instant) from the Salesforce API

Next, do this

Add Request to Queue with the fal.ai 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 fal.ai 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 Add Request to Queue action
1. Connect your fal.ai account
2. Configure App ID
3. Configure Data
4. Optional- Configure Rerun Enabled
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#

Add Request to Queue on fal.ai

Description:Adds a request to the queue for asynchronous processing, including specifying a webhook URL for receiving updates. [See the documentation](https://fal.ai/docs/model-endpoints/queue#queue-endpoints).

Version:0.0.1

Key:fal_ai-add-request-to-queue

View on GitHub

Action Code#

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

export default {
  key: "fal_ai-add-request-to-queue",
  name: "Add Request to Queue",
  description: "Adds a request to the queue for asynchronous processing, including specifying a webhook URL for receiving updates. [See the documentation](https://fal.ai/docs/model-endpoints/queue#queue-endpoints).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    appId: {
      propDefinition: [
        app,
        "appId",
      ],
    },
    data: {
      type: "object",
      label: "Data",
      description: "Additional data to include with the request. [See the documentation](https://fal.ai/models/fal-ai/lora/api#schema-input) for more input fields.",
      default: {
        model_name: "stabilityai/stable-diffusion-xl-base-1.0",
        prompt: "Photo of a european medieval 40 year old queen, silver hair, highly detailed face, detailed eyes, head shot, intricate crown, age spots, wrinkles",
      },
    },
    reRunEnabled: {
      type: "boolean",
      label: "Rerun Enabled",
      description: "Enable the step to rerun to retrieve the request response. [See the documentation](https://pipedream.com/docs/code/nodejs/rerun/#flowrerun).",
      optional: true,
      reloadProps: true,
      default: false,
    },
  },
  additionalProps() {
    if (this.reRunEnabled) {
      return {
        reRunTimeoutInSecs: {
          type: "integer",
          label: "Rerun Timeout",
          description: "The time in seconds to wait before rerunning the step to retrieve the request response. Eg. `30`. [See the documentation](https://pipedream.com/docs/code/nodejs/rerun/#flowrerun).",
          optional: true,
          min: 10,
        },
      };
    }

    return {
      falWebhook: {
        type: "string",
        label: "Webhook URL",
        description: "The URL to receive updates via webhook.",
        optional: true,
      },
    };
  },
  methods: {
    addToQueue({
      appId, ...args
    } = {}) {
      return this.app.post({
        path: `/${appId}`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      context: {
        run: {
          runs,
          callback_request: callbackRequest,
        },
      },
    } = $;

    const {
      app,
      addToQueue,
      appId,
      data,
      falWebhook,
      reRunEnabled,
      reRunTimeoutInSecs,
    } = this;

    if (!reRunEnabled) {
      const response = await addToQueue({
        $,
        appId,
        params: {
          fal_webhook: falWebhook,
        },
        data,
      });

      $.export("$summary", `Successfully added the request to the queue with ID \`${response.request_id}\`.`);
      return response;
    }

    if (runs === 1) {
      const timeout = 1000 * (reRunTimeoutInSecs || 10);
      const { resume_url: resumeUrl } = $.flow.rerun(timeout, null, 1);

      return addToQueue({
        $,
        appId,
        params: {
          fal_webhook: resumeUrl,
        },
        data,
      });
    }

    const response = await app.getRequestResponse({
      $,
      appId,
      requestId: callbackRequest.body?.request_id,
    });

    $.export("$summary", "Successfully retrieved the request response.");
    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
fal.ai	`app`	`app`	This component uses the fal.ai app.
App ID	`appId`	`string`	The unique identifier for the app. Eg. `lora`.
Data	`data`	`object`	Additional data to include with the request. See the documentation for more input fields.
Rerun Enabled	`reRunEnabled`	`boolean`	Enable the step to rerun to retrieve the request response. See the documentation.

Action Authentication#

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