Add Activity with Pipedrive API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for Pipedrive, Slack and 1200+ other apps remarkably fast.

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

Add Activity with the Pipedrive API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Slack 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 Message In Channels (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Optional- Configure Resolve Names
5. Optional- Configure Ignore Bots
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 Message In Channels (Instant) on Slack

Description:Emit new event when a new message is posted to one or more channels

Version:1.0.10

Key:slack-new-message-in-channels

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. When you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions, or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It just makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Here are some examples of automations you can build with Pipedream on Slack:

Automate posting updates to your team channel
Create a bot to answer common questions
Integrate with your existing tools and services
Build a custom dashboard to track your team's progress
Create a bot to handle scheduling and meeting requests
And much more!

Should I use the Slack or Slack Bot app on Pipedream?

The Slack app is the easiest and most convienent option to get started. It installs the official Pipedream bot into your Slack workspace with just a few clicks.

However, if you'd like to use your own bot registered with the Slack API, you can use the Slack Bot app instead.

The Slack Bot requires a bot token to allow your Pipedream workflows to authenticate as your bot. The extra set up steps allow you to list your custom bot on the Slack Marketplace, or install the bot on other workspaces as your bot's name instead of as Pipedream.

Getting Started

You can install the Pipedream Slack app in the Accounts section of your account, or directly in a workflow

Accounts

Visit https://pipedream.com/accounts.
Click on the Click Here To Connect An App button in the top-right.
Search for "Slack" among the list of apps, and select it.
This will open a new window asking you to allow Pipedream access to your Slack workspace. Choose the right workspace where you'd like to install the app, then click Allow.
That's it! You can now use this Slack account in any actions, or link it to any code step.

Within a workflow

Create a new workflow.
Select your trigger (HTTP, Cron, etc.).
Click on the + button below the trigger step, and search for "Slack".
Select the Send a Message action.
Click the Connect Account button near the top of the step. This will prompt you to select any existing Slack accounts you've previously authenticated with Pipedream, or you can select a New account. Clicking New opens a new window asking you to allow Pipedream access to your Slack workspace. Choose the right workspace where you'd like to install the app, then click Allow.
That's it! You can now connect to the Slack API using any of the Slack actions within a Pipedream workflow.

Troubleshooting

Please reach out to the Pipedream team with any technical issues or questions about the Slack integration. We're happy to help!

Trigger Code#

import common from "../common/base.mjs";
import constants from "../common/constants.mjs";

export default {
  ...common,
  key: "slack-new-message-in-channels",
  name: "New Message In Channels (Instant)",
  version: "1.0.10",
  description: "Emit new event when a new message is posted to one or more channels",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Select one or more channels to monitor for new messages.",
      optional: true,
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return this.conversations || [
          "message",
        ];
      },
    },
    resolveNames: {
      propDefinition: [
        common.props.slack,
        "resolveNames",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New message in channel";
    },
    async processEvent(event) {
      if (event.type !== "message") {
        console.log(`Ignoring event with unexpected type "${event.type}"`);
        return;
      }
      if (event.subtype && !constants.ALLOWED_MESSAGE_IN_CHANNEL_SUBTYPES.includes(event.subtype)) {
        // This source is designed to just emit an event for each new message received.
        // Due to inconsistencies with the shape of message_changed and message_deleted
        // events, we are ignoring them for now. If you want to handle these types of
        // events, feel free to change this code!!
        console.log("Ignoring message with subtype.");
        return;
      }
      if ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) {
        return;
      }
      if (this.resolveNames) {
        if (event.user) {
          event.user_id = event.user;
          event.user = await this.getUserName(event.user);
        } else if (event.bot_id) {
          event.bot = await this.getBotName(event.bot_id);
        }
        event.channel_id = event.channel;
        event.channel = await this.getConversationName(event.channel);
        if (event.team) {
          event.team_id = event.team;
          event.team = await this.getTeamName(event.team);
        }
      }
      return event;
    },
  },
};

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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`nameCache`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`
Resolve Names	`resolveNames`	`boolean`	Instead of returning `channel`, `team`, and `user` as IDs, return their human-readable names.
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots

Trigger Authentication#

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

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

bookmarks:writecalls:readcalls:writechannels:historychannels:readchannels:writednd:readdnd:writeemoji:readfiles:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writepins:readpins:writereactions:readreactions:writereminders:readreminders:writeremote_files:readremote_files:sharestars:readstars:writeteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:usercommandsfiles:write:userusers.profile:writeusers.profile:readsearch:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

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#

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:

About Pipedrive#

Sales CRM & Pipeline Management Software

More Ways to Connect Pipedrive + Slack#

Other Popular Integrations#

Add Deal with Pipedrive API on New Message In Channels from Slack API

Slack + Pipedrive