← Pipedrive

Add Activity with Pipedrive API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Add Activity with the Pipedrive API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Add Activity with the Pipedrive API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Add Activity with Pipedrive API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Pipedrive
 
Try it
Add Activity with Pipedrive API on New Item in Feed from RSS API
RSS + Pipedrive
 
Try it
Add Activity with Pipedrive API on New Message from Discord API
Discord + Pipedrive
 
Try it
Add Activity with Pipedrive API on New Message In Channels from Slack API
Slack + Pipedrive
 
Try it
Add Activity with Pipedrive API on New Message in Channel from Discord Bot API
Discord Bot + Pipedrive
 
Try it

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is 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.

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.2
Key:pipedrive-add-activity

Code

import pipedriveApp from "../../pipedrive.app.mjs";
import utils from "../../common/utils.mjs";
import constants from "../../common/constants.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.2",
  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";
    }
  },
};

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.
LabelPropTypeDescription
PipedrivepipedriveAppappThis component uses the Pipedrive app.
Subjectsubjectstring

Subject of the activity

DonedonestringSelect a value from the drop down menu:{ "label": "Not done", "value": "0" }{ "label": "Done", "value": "1" }
TypetypestringSelect a value from the drop down menu.
Due DatedueDatestring

Due date of the activity. Format: YYYY-MM-DD

Due TimedueTimestring

Due time of the activity in UTC. Format: HH:MM

Durationdurationstring

Duration of the activity. Format: HH:MM

User IDuserIdintegerSelect a value from the drop down menu.
Deal IDdealIdstringSelect a value from the drop down menu.
Person IDpersonIdintegerSelect a value from the drop down menu.
Participantsparticipantsstring[]Select a value from the drop down menu.
Organization IDorganizationIdintegerSelect a value from the drop down menu.
Notenotestring

Note of the activity (HTML format)

Locationlocationstring

The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps.

Public DescriptionpublicDescriptionstring

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 FlagbusyFlagboolean

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

Attendeesattendeesstring[]Select a value from the drop down menu.

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 Use Pipedrive

Triggers

New Deal from the Pipedrive API

Triggers when a new deal is created.

 
Try it
New Person from the Pipedrive API

Triggers when a new person is created.

 
Try it
Updated Deal from the Pipedrive API

Triggers when a deal is updated.

 
Try it
Updated Person from the Pipedrive API

Triggers when a person is updated.

 
Try it

Actions

Add Deal with the Pipedrive API

Adds a new deal. See the Pipedrive API docs for Deals here

 
Try it
Add Organization with the Pipedrive API

Adds a new organization. See the Pipedrive API docs for Organizations here

 
Try it
Add Person with the Pipedrive API

Adds a new person. See the Pipedrive API docs for People here

 
Try it
Search persons with the Pipedrive API

Searches all Persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found Persons can be filtered by Organization ID. See the Pipedrive API docs here

 
Try it
Update Deal with the Pipedrive API

Updates the properties of a deal. See the Pipedrive API docs for Deals here

 
Try it