Create Purchase Nudge with Nudgify API on New Record (Instant, of Selectable Type) from Salesforce API

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

Trigger workflow on

New Record (Instant, of Selectable Type) from the Salesforce API

Next, do this

Create Purchase Nudge with the Nudgify 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 Nudgify action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Record (Instant, of Selectable Type) trigger
1. Connect your Salesforce account
2. Configure timer
3. Select a Object Type
4. Optional- Select one or more Fields to Obtain
Configure the Create Purchase Nudge action
1. Connect your Nudgify account
2. Configure Order ID
3. Optional- Configure Items
4. Configure Date
5. Configure Email
6. Optional- Configure First Name
7. Optional- Configure Last Name
8. Optional- Configure IP Address
9. Optional- Configure City
10. Optional- Configure State
11. Optional- Configure Country
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 Record (Instant, of Selectable Type) on Salesforce

Description:Emit new event when a record of the selected object type is created. [See the documentation](https://sforce.co/3yPSJZy)

Version:0.2.0

Key:salesforce_rest_api-new-record-instant

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 startCase from "lodash/startCase.js";
import common from "../common.mjs";

export default {
  ...common,
  type: "source",
  name: "New Record (Instant, of Selectable Type)",
  key: "salesforce_rest_api-new-record-instant",
  description: "Emit new event when a record of the selected object type is created. [See the documentation](https://sforce.co/3yPSJZy)",
  version: "0.2.0",
  props: {
    ...common.props,
    fieldsToObtain: {
      propDefinition: [
        common.props.salesforce,
        "fieldsToObtain",
        (c) => ({
          objType: c.objectType,
        }),
      ],
      optional: true,
      description: "Select the field(s) to be retrieved for the records. Only applicable if the source is running on a timer. If running on a webhook, or if not specified, all fields will be retrieved.",
    },
  },
  hooks: {
    ...common.hooks,
    async deploy() {
      const objectType = this.objectType;
      const nameField = await this.salesforce.getNameFieldForObjectType(objectType);
      this.setNameField(nameField);

      // emit historical events
      const { recentItems } = await this.salesforce.listSObjectTypeIds(objectType);
      const ids = recentItems.map((item) => item.Id);
      for (const id of ids.slice(-25)) {
        const object = await this.salesforce.getSObject(objectType, id);
        const event = {
          body: {
            "New": object,
            "UserId": id,
          },
        };
        this.processWebhookEvent(event);
      }
    },
  },
  methods: {
    ...common.methods,
    generateTimerMeta(item, fieldName) {
      const { objectType } = this;
      const {
        CreatedDate: createdDate,
        [fieldName]: name,
        Id: id,
      } = item;
      const entityType = startCase(objectType);
      const summary = `New ${entityType} created: ${name ?? id}`;
      const ts = Date.parse(createdDate);
      return {
        id,
        summary,
        ts,
      };
    },
    generateWebhookMeta(data) {
      const nameField = this.getNameField();
      const { New: newObject } = data.body;
      const {
        CreatedDate: createdDate,
        Id: id,
        [nameField]: name,
      } = newObject;
      const entityType = startCase(this.objectType).toLowerCase();
      const summary = `New ${entityType} created: ${name ?? id}`;
      const ts = Date.parse(createdDate);
      return {
        id,
        summary,
        ts,
      };
    },
    getEventType() {
      return "new";
    },
    async processTimerEvent(eventData) {
      const {
        paginate,
        objectType,
        setLatestDateCovered,
        getObjectTypeColumns,
        getNameField,
        generateTimerMeta,
        $emit: emit,
      } = this;

      const {
        startTimestamp,
        endTimestamp,
      } = eventData;

      const fieldName = getNameField();
      const columns = getObjectTypeColumns();

      const events = await paginate({
        objectType,
        startTimestamp,
        endTimestamp,
        columns,
      });

      const [
        latestEvent,
      ] = events;

      if (latestEvent?.CreatedDate) {
        const latestDateCovered = new Date(latestEvent.CreatedDate);
        latestDateCovered.setSeconds(0);
        setLatestDateCovered(latestDateCovered.toISOString());
      }

      Array.from(events)
        .reverse()
        .forEach((item) => {
          const meta = generateTimerMeta(item, fieldName);
          emit(item, meta);
        });
    },
    async timerActivateHook() {
      const {
        objectType,
        getObjectTypeDescription,
        setObjectTypeColumns,
      } = this;

      let columns = this.fieldsToObtain;
      if (!columns?.length) {
        const { fields } = await getObjectTypeDescription(objectType);
        columns = fields.map(({ name }) => name);
      }

      setObjectTypeColumns(columns);
    },
  },
};

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
Salesforce	`salesforce`	`app`	This component uses the Salesforce 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.
	`timer`	`$.interface.timer`	The timer is only used as a fallback if instant event delivery (webhook) is not available.
Object Type	`objectType`	`string`	Select a value from the drop down menu.
Fields to Obtain	`fieldsToObtain`	`string[]`	Select a value from the drop down menu.

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 Purchase Nudge on Nudgify

Description:Creates a purchase nudge. [See docs here](https://www.nudgify.com/docs/knowledge-base/api-purchase-nudges/)

Version:0.0.1

Key:nudgify-create-purchase-nudge

View on GitHub

Nudgify Overview#

The Nudgify API lets you create and manage social proof notifications, aimed at increasing user engagement and conversions on your website. By leveraging this API on Pipedream, you can automate the interaction with Nudgify notifications and integrate them into your site's workflow. This could include creating notifications based on user behavior, updating them in real-time as data changes, or deleting them once they're no longer needed. The Pipedream platform simplifies the process of working with the Nudgify API by handling authentication, providing a code-free interface for setting up workflows, and enabling connections with numerous other apps for extended functionality.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import app from "../../nudgify.app.mjs";

export default {
  key: "nudgify-create-purchase-nudge",
  name: "Create Purchase Nudge",
  description: "Creates a purchase nudge. [See docs here](https://www.nudgify.com/docs/knowledge-base/api-purchase-nudges/)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    orderId: {
      type: "integer",
      label: "Order ID",
      description: "The order-id used to identify which items are part of the same order",
    },
    items: {
      type: "string[]",
      label: "Items",
      description: "One or more items as part of the purchase. Each item should be a JSON string and can contain the parameters `item_id`, `item_variation_id`, `item_name`, `item_link` and `image_url`. [See the documentation](https://www.nudgify.com/docs/knowledge-base/api-purchase-nudges/#parameters) for more information.",
      optional: true,
    },
    date: {
      propDefinition: [
        app,
        "date",
      ],
    },
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    firstName: {
      propDefinition: [
        app,
        "firstName",
      ],
    },
    lastName: {
      propDefinition: [
        app,
        "lastName",
      ],
    },
    ip: {
      propDefinition: [
        app,
        "ip",
      ],
    },
    city: {
      propDefinition: [
        app,
        "city",
      ],
    },
    state: {
      propDefinition: [
        app,
        "state",
      ],
    },
    country: {
      propDefinition: [
        app,
        "country",
      ],
    },
  },
  async run({ $ }) {
    const {
      date, orderId, items, email, firstName, lastName, ip, city, state, country,
    } = this;
    const data = {
      orders: [
        {
          order_id: orderId,
          date,
          email,
          first_name: firstName,
          last_name: lastName,
          ip,
          city,
          state,
          country,
        },
      ],
    };

    try {
      if (items) {
        data.orders[0].line_items = items.map((s) => JSON.parse(s));
      }
    } catch (err) {
      throw new ConfigurationError("Error parsing items as JSON. Check that each entry in the array is a valid JSON string.");
    }

    const response = await this.app.createPurchaseNudge({
      $,
      data,
    });
    $.export("$summary", "Successfully created purchase nudge");
    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
Nudgify	`app`	`app`	This component uses the Nudgify app.
Order ID	`orderId`	`integer`	The order-id used to identify which items are part of the same order
Items	`items`	`string[]`	One or more items as part of the purchase. Each item should be a JSON string and can contain the parameters `item_id`, `item_variation_id`, `item_name`, `item_link` and `image_url`. See the documentation for more information.
Date	`date`	`string`	The date (UTC) used to show in the Nudge how long ago the conversion took place. Format: `YYYY-MM-DD HH:MM:SS` (example: `2021-04-15 04:29:42`)
Email	`email`	`string`	The email address of the user
First Name	`firstName`	`string`	The first name of the user
Last Name	`lastName`	`string`	The last name of the user
IP Address	`ip`	`string`	The IP address of the user
City	`city`	`string`	The city of the user
State	`state`	`string`	The state of the user
Country	`country`	`string`	The country of the user (max 2 characters, e.g. `GB`, `US`)

Action Authentication#

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

You can find the Site and API Keys for each site in your Nudgify account on your Sites page.