Add Activity with Pipedrive API on New Outbound Message (Instant) from Salesforce API

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

Trigger workflow on

New Outbound Message (Instant) from the Salesforce API

Next, do this

Add Activity with the Pipedrive 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 Pipedrive 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 Activity action
1. Connect your Pipedrive account
2. Configure Subject
3. Optional- Select a Done
4. Select a Type
5. Optional- Configure Due Date
6. Optional- Configure Due Time
7. Optional- Configure Duration
8. Optional- Select a User ID
9. Optional- Select a Deal ID
10. Optional- Select a Person ID
11. Optional- Select one or more Participants
12. Optional- Select a Organization ID
13. Optional- Configure Note
14. Optional- Configure Location
15. Optional- Configure Public Description
16. Optional- Configure Busy Flag
17. Optional- Select one or more Attendees
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 Activity on Pipedrive

Description:Adds a new activity. Includes `more_activities_scheduled_in_context` property in response's `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). See the Pipedrive API docs for Activities [here](https://developers.pipedrive.com/docs/api/v1/#!/Activities). For info on [adding an activity in Pipedrive](https://developers.pipedrive.com/docs/api/v1/Activities#addActivity)

Version:0.1.5

Key:pipedrive-add-activity

View on GitHub

Pipedrive Overview#

Pipedrive API on Pipedream allows you to create powerful sales automation and data management workflows. With access to Pipedrive's CRM capabilities, you can automate deal updates, contact management, and sales reporting. Whether you're syncing customer information across platforms or triggering actions based on deal stages, Pipedream makes these integrations seamless.

Action Code#

import constants from "../../common/constants.mjs";
import utils from "../../common/utils.mjs";
import pipedriveApp from "../../pipedrive.app.mjs";

export default {
  key: "pipedrive-add-activity",
  name: "Add Activity",
  description: "Adds a new activity. Includes `more_activities_scheduled_in_context` property in response's `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). See the Pipedrive API docs for Activities [here](https://developers.pipedrive.com/docs/api/v1/#!/Activities). For info on [adding an activity in Pipedrive](https://developers.pipedrive.com/docs/api/v1/Activities#addActivity)",
  version: "0.1.5",
  type: "action",
  props: {
    pipedriveApp,
    subject: {
      type: "string",
      label: "Subject",
      description: "Subject of the activity",
    },
    done: {
      type: "string",
      label: "Done",
      description: "Whether the activity is done or not. 0 = Not done, 1 = Done",
      optional: true,
      options: [
        {
          label: "Not done",
          value: "0",
        },
        {
          label: "Done",
          value: "1",
        },
      ],
    },
    type: {
      type: "string",
      label: "Type",
      description: "Type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes.",
      async options() {
        const { data: activityTypes } = await this.pipedriveApp.getActivityTypes();
        return activityTypes.map(({
          key_string: value, name,
        }) => ({
          label: name,
          value,
        }));
      },
    },
    dueDate: {
      type: "string",
      label: "Due Date",
      description: "Due date of the activity. Format: `YYYY-MM-DD`",
      optional: true,
    },
    dueTime: {
      type: "string",
      label: "Due Time",
      description: "Due time of the activity in UTC. Format: `HH:MM`",
      optional: true,
    },
    duration: {
      type: "string",
      label: "Duration",
      description: "Duration of the activity. Format: `HH:MM`",
      optional: true,
    },
    userId: {
      propDefinition: [
        pipedriveApp,
        "userId",
      ],
      description: "ID of the user whom the activity will be assigned to. If omitted, the activity will be assigned to the authorized user.",
    },
    dealId: {
      propDefinition: [
        pipedriveApp,
        "dealId",
      ],
    },
    personId: {
      propDefinition: [
        pipedriveApp,
        "personId",
      ],
      description: "ID of the person this activity will be associated with",
    },
    participants: {
      type: "string[]",
      label: "Participants",
      description: "List of multiple persons (participants) this activity will be associated with. If omitted, single participant from `person_id` field is used. It requires a structure as follows: `[{\"person_id\":1,\"primary_flag\":true}]`",
      optional: true,
      propDefinition: [
        pipedriveApp,
        "personId",
      ],
    },
    organizationId: {
      propDefinition: [
        pipedriveApp,
        "organizationId",
      ],
      description: "ID of the organization this activity will be associated with",
    },
    note: {
      type: "string",
      label: "Note",
      description: "Note of the activity (HTML format)",
      optional: true,
    },
    location: {
      type: "string",
      label: "Location",
      description: "The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps.",
      optional: true,
    },
    publicDescription: {
      type: "string",
      label: "Public Description",
      description: "Additional details about the activity that will be synced to your external calendar. Unlike the note added to the activity, the description will be publicly visible to any guests added to the activity.",
      optional: true,
    },
    busyFlag: {
      type: "boolean",
      label: "Busy Flag",
      description: "Set the activity as 'Busy' or 'Free'. If the flag is set to true, your customers will not be able to book that time slot through any Scheduler links",
      optional: true,
    },
    attendees: {
      type: "string[]",
      label: "Attendees",
      description: "Attendees of the activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: `[{\"email_address\":\"mail@example.org\"}]` or `[{\"person_id\":1, \"email_address\":\"mail@example.org\"}]`",
      optional: true,
      async options({ prevContext }) {
        const {
          moreItemsInCollection,
          start,
        } = prevContext;

        if (moreItemsInCollection === false) {
          return [];
        }

        const {
          data: persons,
          additional_data: additionalData,
        } = await this.pipedriveApp.getPersons({
          start,
          limit: constants.DEFAULT_PAGE_LIMIT,
        });

        const options =
          persons?.flatMap(({
            name, email,
          }) => email?.map(({ value }) => ({
            label: name,
            value,
          })).filter((option) => option?.value));

        return {
          options,
          context: {
            moreItemsInCollection: additionalData.pagination.more_items_in_collection,
            start: additionalData.pagination.next_start,
          },
        };
      },
    },
  },
  async run({ $ }) {
    const {
      subject,
      type,
      dueDate,
      dueTime,
      duration,
      userId,
      dealId,
      personId,
      organizationId,
      note,
      location,
      publicDescription,
      busyFlag,
    } = this;

    const participants = utils.parseOrUndefined(this.participants);
    const attendees = utils.parseOrUndefined(this.attendees);
    const done = utils.parseOrUndefined(this.done);

    try {
      const resp =
        await this.pipedriveApp.addActivity({
          subject,
          done,
          type,
          due_date: dueDate,
          due_time: dueTime,
          duration,
          user_id: userId,
          deal_id: dealId,
          person_id: personId,
          participants: participants?.map((value, idx) => ({
            person_id: value,
            primary_flag: !idx,
          })),
          org_id: organizationId,
          note,
          location,
          public_description: publicDescription,
          busy_flag: busyFlag,
          attendees: attendees?.map((value) => ({
            email_address: value,
          })),
        });

      $.export("$summary", "Successfully added activity");

      return resp;
    } catch (error) {
      console.error(error.context?.body || error);
      throw error.context?.body?.error || "Failed to add activity";
    }
  },
};

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
Pipedrive	`pipedriveApp`	`app`	This component uses the Pipedrive app.
Subject	`subject`	`string`	Subject of the activity
Done	`done`	`string`	Select a value from the drop down menu:`{ "label": "Not done", "value": "0" }{ "label": "Done", "value": "1" }`
Type	`type`	`string`	Select a value from the drop down menu.
Due Date	`dueDate`	`string`	Due date of the activity. Format: `YYYY-MM-DD`
Due Time	`dueTime`	`string`	Due time of the activity in UTC. Format: `HH:MM`
Duration	`duration`	`string`	Duration of the activity. Format: `HH:MM`
User ID	`userId`	`integer`	Select a value from the drop down menu.
Deal ID	`dealId`	`string`	Select a value from the drop down menu.
Person ID	`personId`	`integer`	Select a value from the drop down menu.
Participants	`participants`	`string[]`	Select a value from the drop down menu.
Organization ID	`organizationId`	`integer`	Select a value from the drop down menu.
Note	`note`	`string`	Note of the activity (HTML format)
Location	`location`	`string`	The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps.
Public Description	`publicDescription`	`string`	Additional details about the activity that will be synced to your external calendar. Unlike the note added to the activity, the description will be publicly visible to any guests added to the activity.
Busy Flag	`busyFlag`	`boolean`	Set the activity as 'Busy' or 'Free'. If the flag is set to true, your customers will not be able to book that time slot through any Scheduler links
Attendees	`attendees`	`string[]`	Select a value from the drop down menu.

Action Authentication#

Pipedrive uses OAuth authentication. When you connect your Pipedrive account, Pipedream will open a popup window where you can sign into Pipedrive and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Pipedrive API.

Pipedream requests the following authorization scopes when you connect your account:

Add Activity with Pipedrive API on New Outbound Message (Instant) from Salesforce API

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