← Workiz + Pipedrive integrations

Add Activity with Pipedrive API on New Job Created from Workiz API

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

Trigger workflow on
New Job Created from the Workiz API
Next, do this
Add Activity with the Pipedrive API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

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

  1. Select this integration
  2. Configure the New Job Created trigger
    1. Connect your Workiz account
    2. Configure timer
  3. 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
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. 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

Description:Emit new event when a new job is created in Workiz. [See the documentation](https://developer.workiz.com/)
Version:0.0.1
Key:workiz-new-job-created

Workiz Overview

The Workiz API opens up a world of possibilities for managing field service operations. By tapping into Workiz with Pipedream, you can automate workflows, sync data across apps, and react to events in real-time. Whether you're automating job scheduling, dispatch notifications, or customer follow-ups, integrating Workiz with Pipedream allows you to streamline operations, reduce manual entry, and keep your team in sync.

Trigger Code

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

export default {
  ...common,
  key: "workiz-new-job-created",
  name: "New Job Created",
  description: "Emit new event when a new job is created in Workiz. [See the documentation](https://developer.workiz.com/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.workiz.listJobs;
    },
    generateMeta(job) {
      return {
        id: job.UUID,
        summary: `New Job ${job.UUID}`,
        ts: Date.parse(job.CreatedDate),
      };
    },
  },
};

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.
LabelPropTypeDescription
WorkizworkizappThis component uses the Workiz app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between executions.
timer$.interface.timer

Trigger Authentication

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

Enable the API in Workiz Marketpace and generate your API Credentials from the Developer add-on page.

About Workiz

Workiz is the #1 all-in-one management platform for fieldservice businesses, including hvac, plumbing, garagedoor, electrcialcontracting, and more.

Action

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

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.

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.

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

Pipedrive is the easy-to-use, #1 user-rated CRM tool. Get more qualified leads and grow your business with Pipedrive's sales CRM.

More Ways to Connect Pipedrive + Workiz

Create Lead with Workiz API on New Deal from Pipedrive API
Pipedrive + Workiz
 
Try it
Create Lead with Workiz API on New Person from Pipedrive API
Pipedrive + Workiz
 
Try it
Create Lead with Workiz API on Updated Deal from Pipedrive API
Pipedrive + Workiz
 
Try it
Create Lead with Workiz API on Updated Person from Pipedrive API
Pipedrive + Workiz
 
Try it
Create Job with Workiz API on New Deal from Pipedrive API
Pipedrive + Workiz
 
Try it
New Job Created from the Workiz API

Emit new event when a new job is created in Workiz. See the documentation

 
Try it
New Lead Created from the Workiz API

Emit new event when a new lead is created in Workiz. See the documentation

 
Try it
New Deal from the Pipedrive API

Emit new event when a new deal is created.

 
Try it
New Person from the Pipedrive API

Emit new event when a new person is created.

 
Try it
Updated Deal from the Pipedrive API

Emit new event when a deal is updated.

 
Try it
Create Job with the Workiz API

Creates a new job in Workiz. See the documentation

 
Try it
Create Lead with the Workiz API

Create a new lead in Workiz. See the documentation

 
Try it
Add Activity with the Pipedrive API

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. For info on adding an activity in Pipedrive

 
Try it
Add Deal with the Pipedrive API

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

 
Try it
Add Note with the Pipedrive API

Adds a new note. For info on adding an note in Pipedrive

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
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.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.