Create Program with Fidel API API on New Outbound Message (Instant) from Salesforce API

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

Trigger workflow on

New Outbound Message (Instant) from the Salesforce API

Next, do this

Create Program with the Fidel API 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 Fidel API 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 Create Program action
1. Connect your Fidel API account
2. Configure Program Name
3. Optional- Configure Icon
4. Optional- Configure Icon Background
5. Optional- Configure Metadata
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#

Create Program on Fidel API

Description:Creates a new card-linked program in the Fidel API. [See the documentation](https://reference.fidel.uk/reference/create-program)

Version:0.0.1

Key:fidel_api-create-program

View on GitHub

Fidel API Overview#

The Fidel API allows you to link credit and debit cards to specific offers or programs, track transactions in real-time, and receive event-driven data. It's a powerful tool for creating loyalty and reward programs, providing insights into customer spending patterns, and automating financial operations. With Pipedream, you can craft workflows that leverage Fidel API's capabilities to trigger actions, sync data, and connect with other apps for enhanced automation.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import fidelApi from "../../fidel_api.app.mjs";

export default {
  key: "fidel_api-create-program",
  name: "Create Program",
  description: "Creates a new card-linked program in the Fidel API. [See the documentation](https://reference.fidel.uk/reference/create-program)",
  version: "0.0.1",
  type: "action",
  props: {
    fidelApi,
    name: {
      type: "string",
      label: "Program Name",
      description: "The name of the Program. Must be between 4 and 50 characters.",
    },
    icon: {
      type: "string",
      label: "Icon",
      description: "Emoji to associate with the Program. Uses the `:emoji-name:` format. Must be between 4 and 200 characters.",
      optional: true,
    },
    iconBackground: {
      type: "string",
      label: "Icon Background",
      description: "Background color for the program icon. Accepts a HEX CSS string, like '#333333'.",
      optional: true,
    },
    metadata: {
      propDefinition: [
        fidelApi,
        "metadata",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.fidelApi.createProgram({
      data: {
        name: this.name,
        icon: this.icon,
        iconBackground: this.iconBackground,
        metadata: parseObject(this.metadata),
      },
    });

    $.export("$summary", `Successfully created program with ID: ${response.items[0]?.id}`);
    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
Fidel API	`fidelApi`	`app`	This component uses the Fidel API app.
Program Name	`name`	`string`	The name of the Program. Must be between 4 and 50 characters.
Icon	`icon`	`string`	Emoji to associate with the Program. Uses the `:emoji-name:` format. Must be between 4 and 200 characters.
Icon Background	`iconBackground`	`string`	Background color for the program icon. Accepts a HEX CSS string, like '#333333'.
Metadata	`metadata`	`object`	Metadata related to the card, program, or transaction.

Action Authentication#

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

To retrieve your API Key,

Navigate to your Fidel API account and sign in
Click the dropdown on the top left
Go to “Account settings” > “Plan” > “API Keys”

About Fidel API#

Make money programmable: Fidel API enables developers to build transformative experiences on top of payment cards.

More Ways to Connect Fidel API + Salesforce#

Other Popular Integrations#

Delete Card with Fidel API API on New Outbound Message (Instant) from Salesforce (REST API) API

Salesforce + Fidel API

Create Program with Fidel API API on New Outbound Message (Instant) from Salesforce API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular