List Employees with Buddee API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Buddee, Pipedream and 2,800+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

List Employees with the Buddee 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 Pipedream trigger and Buddee action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the List Employees action
1. Connect your Buddee account
2. Optional- Select a Job ID
3. Optional- Select a Location ID
4. Optional- Select a Buddy ID
5. Optional- Select a Manager ID
6. Optional- Select a Indirect Manager ID
7. Optional- Select a HR Manager ID
8. Optional- Select a Cost Center ID
9. Optional- Select a Cost Unit ID
10. Optional- Configure Full Name
11. Optional- Configure Work Email
12. Optional- Configure Personal Email
13. Optional- Configure Active
14. Optional- Configure Employed or Archived in Period
15. Optional- Configure Active in Period
16. Optional- Configure Archived
17. Optional- Select a Contract Duration
18. Optional- Select a Contract Type
19. Optional- Select a Employment Type
20. Optional- Select a Manager ID
21. Optional- Select a Work Schedule Type
22. Optional- Configure Max Results
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

List Employees on Buddee

Description:Retrieve a complete list of employees. [See the documentation](https://developers.buddee.nl/#fd057d3c-8b40-4808-a4d2-eeffc5da82d7)

Version:0.0.1

Key:buddee-list-employees

View on GitHub

Action Code#

import buddee from "../../buddee.app.mjs";
import {
  CONTRACT_DURATION_OPTIONS, CONTRACT_TYPE_OPTIONS,
  EMPLOYMENT_TYPE_OPTIONS,
  WORK_SCHEDULE_TYPE_OPTIONS,
} from "../../common/constants.mjs";

export default {
  name: "List Employees",
  description: "Retrieve a complete list of employees. [See the documentation](https://developers.buddee.nl/#fd057d3c-8b40-4808-a4d2-eeffc5da82d7)",
  key: "buddee-list-employees",
  version: "0.0.1",
  type: "action",
  props: {
    buddee,
    jobId: {
      propDefinition: [
        buddee,
        "jobId",
      ],
      description: "Filter employees by job ID",
      optional: true,
    },
    locationId: {
      propDefinition: [
        buddee,
        "locationId",
      ],
      description: "Filter employees by location ID",
      optional: true,
    },
    buddyId: {
      propDefinition: [
        buddee,
        "employeeId",
      ],
      label: "Buddy ID",
      description: "Filter employees by buddy ID",
      optional: true,
    },
    managerId: {
      propDefinition: [
        buddee,
        "employeeId",
      ],
      label: "Manager ID",
      description: "Filter employees by manager ID",
      optional: true,
    },
    indirectManagerId: {
      propDefinition: [
        buddee,
        "employeeId",
      ],
      label: "Indirect Manager ID",
      description: "Filter employees by indirect manager ID",
      optional: true,
    },
    hrManagerId: {
      propDefinition: [
        buddee,
        "employeeId",
      ],
      label: "HR Manager ID",
      description: "Filter employees by HR manager ID",
      optional: true,
    },
    costCenterId: {
      propDefinition: [
        buddee,
        "costCenterId",
      ],
      description: "Filter employees by cost center ID",
      optional: true,
    },
    costUnitId: {
      propDefinition: [
        buddee,
        "costUnitId",
      ],
      description: "Filter employees by cost unit ID",
      optional: true,
    },
    fullName: {
      type: "string",
      label: "Full Name",
      description: "Filter employees by full name",
      optional: true,
    },
    workEmail: {
      type: "string",
      label: "Work Email",
      description: "Filter employees by work email address",
      optional: true,
    },
    personalEmail: {
      type: "string",
      label: "Personal Email",
      description: "Filter employees by personal email address",
      optional: true,
    },
    active: {
      type: "boolean",
      label: "Active",
      description: "Filter by active or archived employees based on the boolean value",
      optional: true,
    },
    employedOrArchivedInPeriod: {
      type: "string",
      label: "Employed or Archived in Period",
      description: "Filter employees employed or archived within a specified date range",
      optional: true,
    },
    activeInPeriod: {
      type: "string",
      label: "Active in Period",
      description: "Filter employees active within a specific period",
      optional: true,
    },
    archived: {
      type: "boolean",
      label: "Archived",
      description: "Filter employees by archived status",
      optional: true,
    },
    contractDuration: {
      type: "string",
      label: "Contract Duration",
      description: "Filter employees by the duration of their contract",
      options: CONTRACT_DURATION_OPTIONS,
      optional: true,
    },
    contractType: {
      type: "string",
      label: "Contract Type",
      description: "Filter employees by the type of contract",
      options: CONTRACT_TYPE_OPTIONS,
      optional: true,
    },
    employmentType: {
      type: "string",
      label: "Employment Type",
      description: "Filter employees by the type of employment",
      options: EMPLOYMENT_TYPE_OPTIONS,
      optional: true,
    },
    manager: {
      propDefinition: [
        buddee,
        "employeeId",
      ],
      label: "Manager ID",
      description: "Filter employees by manager ID",
      optional: true,
    },
    workScheduleType: {
      type: "string",
      label: "Work Schedule Type",
      description: "Filter employees by the type of work schedule",
      options: WORK_SCHEDULE_TYPE_OPTIONS,
      optional: true,
    },
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "The maximum number of results to return",
      optional: true,
    },
  },
  async run({ $ }) {

    const response = this.buddee.paginate({
      $,
      fn: this.buddee.getEmployees,
      maxResults: this.maxResults,
      params: {
        job_id: this.jobId,
        location_id: this.locationId,
        buddy_id: this.buddyId,
        manager_id: this.managerId,
        indirect_manager_id: this.indirectManagerId,
        hr_manager_id: this.hrManagerId,
        cost_center_id: this.costCenterId,
        cost_unit_id: this.costUnitId,
        full_name: this.fullName,
        work_email: this.workEmail,
        personal_email: this.personalEmail,
        active: this.active,
        employed_or_archived_in_period: this.employedOrArchivedInPeriod,
        active_in_period: this.activeInPeriod,
        archived: this.archived,
        contract_duration: this.contractDuration,
        contract_type: this.contractType,
        employment_type: this.employmentType,
        manager: this.manager,
        work_schedule_type: this.workScheduleType,
      },
    });

    const responseArray = [];
    for await (const employee of response) {
      responseArray.push(employee);
    }

    $.export("$summary", `Found ${responseArray.length} employees`);
    return responseArray;
  },
};

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
Buddee	`buddee`	`app`	This component uses the Buddee app.
Job ID	`jobId`	`string`	Select a value from the drop down menu.
Location ID	`locationId`	`string`	Select a value from the drop down menu.
Buddy ID	`buddyId`	`string`	Select a value from the drop down menu.
Manager ID	`managerId`	`string`	Select a value from the drop down menu.
Indirect Manager ID	`indirectManagerId`	`string`	Select a value from the drop down menu.
HR Manager ID	`hrManagerId`	`string`	Select a value from the drop down menu.
Cost Center ID	`costCenterId`	`string`	Select a value from the drop down menu.
Cost Unit ID	`costUnitId`	`string`	Select a value from the drop down menu.
Full Name	`fullName`	`string`	Filter employees by full name
Work Email	`workEmail`	`string`	Filter employees by work email address
Personal Email	`personalEmail`	`string`	Filter employees by personal email address
Active	`active`	`boolean`	Filter by active or archived employees based on the boolean value
Employed or Archived in Period	`employedOrArchivedInPeriod`	`string`	Filter employees employed or archived within a specified date range
Active in Period	`activeInPeriod`	`string`	Filter employees active within a specific period
Archived	`archived`	`boolean`	Filter employees by archived status
Contract Duration	`contractDuration`	`string`	Select a value from the drop down menu:`temporarypermanent`
Contract Type	`contractType`	`string`	Select a value from the drop down menu:`zero-hoursmin-max`
Employment Type	`employmentType`	`string`	Select a value from the drop down menu:`employeeinternself-employedagency_workerdgavolunteer`
Manager ID	`manager`	`string`	Select a value from the drop down menu.
Work Schedule Type	`workScheduleType`	`string`	Select a value from the drop down menu:`full-timepart-timeon-call`
Max Results	`maxResults`	`integer`	The maximum number of results to return

Action Authentication#

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

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

About Buddee#

HR & Payroll for SMEs, hassle-free!

More Ways to Connect Buddee + Pipedream#

Other Popular Integrations#

Create Employee with Buddee API on New Scheduled Tasks from Pipedream API

Pipedream + Buddee

List Employees with Buddee API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Buddee, Pipedream and 2,800+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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