Emergency Push Notification with Pushover API on New Outbound Message (Instant) from Salesforce API

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

Trigger workflow on

New Outbound Message (Instant) from the Salesforce API

Next, do this

Emergency Push Notification with the Pushover 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 Pushover 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 Emergency Push Notification action
1. Connect your Pushover account
2. Configure Message
3. Configure Retry
4. Configure Expire
5. Optional- Configure Callback
6. Optional- Configure Title
7. Optional- Configure URL
8. Optional- Configure URL Title
9. Optional- Configure Device
10. Optional- Select a Sound
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#

Emergency Push Notification on Pushover

Description:Sends an Emergency Push Notification to devices with Pushover. Notifications are repeated until they are acknowledged by the user. More information at [Pushing Messages](https://pushover.net/api#messages) and [Message Priority](https://pushover.net/api#priority)

Version:0.0.4

Key:pushover-emergency-push-notification

View on GitHub

Pushover Overview#

Pushover makes it easy to send real-time notifications to your Android and iOS devices. By leveraging the Pushover API on Pipedream, you can craft customized messages triggered by various events and send them to users instantly. This integration can be especially useful for monitoring systems, to-do list reminders, or even to keep tabs on your online services and workflows.

Action Code#

import pushover from "../../pushover.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "pushover-emergency-push-notification",
  name: "Emergency Push Notification",
  description: `Sends an Emergency Push Notification to devices with Pushover.
    Notifications are repeated until they are acknowledged by the user.
    More information at [Pushing Messages](https://pushover.net/api#messages) and [Message Priority](https://pushover.net/api#priority)`,
  version: "0.0.4",
  type: "action",
  props: {
    pushover,
    message: {
      propDefinition: [
        pushover,
        "message",
      ],
    },
    retry: {
      propDefinition: [
        pushover,
        "retry",
      ],
    },
    expire: {
      propDefinition: [
        pushover,
        "expire",
      ],
    },
    callback: {
      type: "string",
      label: "Callback",
      description: "A publicly-accessible URL that Pushover will send a request to when the user has acknowledged the notification",
      optional: true,
    },
    title: {
      propDefinition: [
        pushover,
        "title",
      ],
    },
    url: {
      propDefinition: [
        pushover,
        "url",
      ],
    },
    urlTitle: {
      propDefinition: [
        pushover,
        "urlTitle",
      ],
    },
    device: {
      propDefinition: [
        pushover,
        "device",
      ],
    },
    sound: {
      propDefinition: [
        pushover,
        "sound",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      message,
      title,
      url,
      urlTitle,
      device,
      retry,
      expire,
      sound,
      callback,
    } = this;
    const response = await this.pushover.pushMessage({
      $,
      params: {
        message,
        title,
        url,
        device,
        priority: constants.PRIORITY.EMERGENCY,
        retry,
        expire,
        sound,
        callback,
        url_title: urlTitle,
      },
    });
    $.export("$summary", `Successfully sent emergency notification with message: "${message}"`);

    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
Pushover	`pushover`	`app`	This component uses the Pushover app.
Message	`message`	`string`	The notification message
Retry	`retry`	`integer`	How often, in seconds, Pushover will send the same notification. In a situation where your user might be in a noisy environment or sleeping, retrying the notification (with sound and vibration) will help get his or her attention. This parameter must have a value of at least 30 seconds between retries.
Expire	`expire`	`integer`	Notification expiration time, in seconds. If the notification has not been acknowledged in expire seconds, it will be marked as expired and will stop being sent to the user. Note that the notification is still shown to the user after it is expired, but it will not prompt the user for acknowledgement. This parameter must have a maximum value of at most 10800 seconds (3 hours).
Callback	`callback`	`string`	A publicly-accessible URL that Pushover will send a request to when the user has acknowledged the notification
Title	`title`	`string`	The message title
URL	`url`	`string`	A supplementary URL to show with the message
URL Title	`urlTitle`	`string`	A title for the supplementary URL. If blank, the URL is shown
Device	`device`	`string`	The device name to send the message directly. Can be comma-separated names for sending to multiple devices
Sound	`sound`	`string`	Select a value from the drop down menu.

Action Authentication#

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

About Pushover#

Pushover is a simple push notification service that integrates easily into web apps like IFTTT, network monitoring systems, shell scripts, servers, and more.