Convert SOAP XML Object to JSON with Salesforce API on New Incoming SMS (Instant) from ClickSend SMS API

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

Trigger workflow on

New Incoming SMS (Instant) from the ClickSend SMS API

Next, do this

Convert SOAP XML Object to JSON 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#

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

Select this integration
Configure the New Incoming SMS (Instant) trigger
1. Connect your ClickSend SMS account
2. Select a Dedicated Number
3. Configure Message Search Term
Configure the Convert SOAP XML Object to JSON action
1. Connect your Salesforce account
2. Configure infoBox
3. Configure XML Soap Object
4. Optional- Configure Extract Notifications Only
5. Optional- Configure Fail on Error
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 Incoming SMS (Instant) on ClickSend SMS

Description:Emit new event for each new incoming SMS message received. [See the documentation](https://developers.clicksend.com/docs/rest/v3/#view-inbound-sms)

Version:0.0.1

Key:clicksend-new-incoming-sms-instant

View on GitHub

ClickSend SMS Overview#

The ClickSend SMS API unlocks the potential to integrate robust messaging capabilities into your workflows. With Pipedream, you can not only send SMS messages programmatically but also automate notifications, streamline communication based on events, and much more. Whether you're confirming orders, alerting staff, or engaging with customers, ClickSend and Pipedream make these tasks seamless.

Trigger Code#

import constants from "../../common/constants.mjs";
import common from "../common/webhook.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "clicksend-new-incoming-sms-instant",
  name: "New Incoming SMS (Instant)",
  description: "Emit new event for each new incoming SMS message received. [See the documentation](https://developers.clicksend.com/docs/rest/v3/#view-inbound-sms)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    dedicatedNumber: {
      propDefinition: [
        common.props.app,
        "dedicatedNumber",
      ],
    },
    messageSearchTerm: {
      type: "string",
      label: "Message Search Term",
      description: "Search for a specific message. Eg `hello world`",
    },
  },
  hooks: {
    async activate() {
      const {
        http: { endpoint: actionAddress },
        dedicatedNumber,
        messageSearchTerm,
        createSMSInboundAutomation,
        setWebhookId,
      } = this;

      const response =
        await createSMSInboundAutomation({
          data: {
            dedicated_number: dedicatedNumber,
            rule_name: "PD Inbound SMS",
            message_search_type: constants.MSG_SEARCH_TYPE.ANY_MSG,
            message_search_term: messageSearchTerm,
            action: constants.ACTION.URL,
            action_address: actionAddress,
            enabled: constants.ENABLED,
            webhook_type: constants.WEBHOOK_TYPE.JSON,
          },
        });

      setWebhookId(response.data.inbound_rule_id);
    },
    async deactivate() {
      const {
        getWebhookId,
        deleteSMSInboundAutomation,
      } = this;

      const inboundRuleId = getWebhookId();
      if (inboundRuleId) {
        await deleteSMSInboundAutomation({
          inboundRuleId,
        });
      }
    },
  },
  methods: {
    ...common.methods,
    createSMSInboundAutomation(args = {}) {
      return this.app.post({
        debug: true,
        path: "/automations/sms/inbound",
        ...args,
      });
    },
    deleteSMSInboundAutomation({
      inboundRuleId, ...args
    } = {}) {
      return this.app.delete({
        debug: true,
        path: `/automations/sms/inbound/${inboundRuleId}`,
        ...args,
      });
    },
    generateMeta(resource) {
      return {
        id: resource.message_id,
        summary: `New SMS: ${resource.message_id}`,
        ts: Date.parse(resource.timestamp),
      };
    },
  },
  sampleEmit,
};

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
ClickSend SMS	`app`	`app`	This component uses the ClickSend SMS app.
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.
Dedicated Number	`dedicatedNumber`	`string`	Select a value from the drop down menu.
Message Search Term	`messageSearchTerm`	`string`	Search for a specific message. Eg `hello world`

Trigger Authentication#

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

Please enter your ClickSend username and API key below.

See the ClickSend docs for more information.

About ClickSend SMS#

Business Communications. Solved.

Action#

Convert SOAP XML Object to JSON on Salesforce

Description:Converts a SOAP XML Object received from Salesforce to JSON

Version:0.0.6

Key:salesforce_rest_api-convert-soap-xml-to-json

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.

Action Code#

import salesforce_rest_api from "../../salesforce_rest_api.app.mjs";
import converter from "../../../helper_functions/actions/xml-to-json/xml-to-json.mjs";

export default {
  key: "salesforce_rest_api-convert-soap-xml-to-json",
  name: "Convert SOAP XML Object to JSON",
  description: "Converts a SOAP XML Object received from Salesforce to JSON",
  version: "0.0.6",
  type: "action",
  props: {
    salesforce_rest_api,
    infoBox: {
      type: "alert",
      alertType: "info",
      content: `This action is useful in conjunction with Salesforce Flow Builder, and is primarily used if Instant triggers are not working for your use case.
\\
[See the documentation](https://pipedream.com/apps/salesforce-rest-api#troubleshooting) for more details.`,
    },
    xml: {
      type: "string",
      label: "XML Soap Object",
      description: "The object received from Salesforce that will be converted.",
    },
    extractNotificationOnly: {
      type: "boolean",
      label: "Extract Notifications Only",
      description: "Whether to extract only the notification parts from the XML. Default: `true`.",
      optional: true,
      default: true,
    },
    failOnError: {
      type: "boolean",
      label: "Fail on Error",
      description: "Whether the action should fail if an error occurs when extracting notifications. Default: `false`.",
      optional: true,
      default: false,
    },
  },
  async run({ $ }) {
    const json = await converter.run.bind({
      input: this.xml,
      compact: false,
    })({
      $,
    });

    if (!this.extractNotificationOnly) {
      return json;
    }

    try {
      const notifications = json.elements[0].elements[0].elements[0].elements
        .filter(({ name }) => name === "Notification");
      $.export("$summary", "Successfully converted to JSON and extracted notifications");
      return {
        notifications,
      };
    } catch (e) {
      const errorMessage = "Successfully converted to JSON, but was unable to extract notifications";
      if (this.failOnError) {
        $.export("$summary", errorMessage); // overrides exported $summary in converter
        throw new Error(errorMessage);
      }

      $.export("$summary", `${errorMessage}. Will return the whole JSON.`);
      return json;
    }
  },
};

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
Salesforce	`salesforce_rest_api`	`app`	This component uses the Salesforce app.
XML Soap Object	`xml`	`string`	The object received from Salesforce that will be converted.
Extract Notifications Only	`extractNotificationOnly`	`boolean`	Whether to extract only the notification parts from the XML. Default: `true`.
Fail on Error	`failOnError`	`boolean`	Whether the action should fail if an error occurs when extracting notifications. Default: `false`.

Action 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

More Ways to Connect Salesforce + ClickSend SMS#

Other Popular Integrations#

Send MMS with ClickSend SMS API on New Outbound Message (Instant) from Salesforce (REST API) API

Salesforce + ClickSend SMS

Convert SOAP XML Object to JSON with Salesforce API on New Incoming SMS (Instant) from ClickSend SMS API

Pipedream makes it easy to connect APIs for Salesforce, ClickSend SMS 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