List Employees with Buddee API on New Contact from Twilio SendGrid API

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

Trigger workflow on

New Contact from the Twilio SendGrid 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 Twilio SendGrid 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 Contact trigger
1. Connect your Twilio SendGrid account
2. Configure timer
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 Contact on Twilio SendGrid

Description:Emit new event when a new contact is created

Version:0.0.8

Key:sendgrid-new-contact

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import orderBy from "lodash/orderBy.js";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "sendgrid-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is created",
  version: "0.0.8",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const currentTimestamp = Date.now();
      const state = {
        processedItems: [],
        lowerTimestamp: currentTimestamp,
        upperTimestamp: currentTimestamp,
      };
      this.db.set("state", state);
    },
  },
  methods: {
    ...common.methods,
    _maxDelayTime() {
      // There is no report from SendGrid as to how much time it takes
      // for a contact to be created and appear in search results, so
      // we're using a rough estimate of 30 minutes here.
      return 30 * 60 * 1000;  // 30 minutes, in milliseconds
    },
    _addDelayOffset(timestamp) {
      return timestamp - this._maxDelayTime();
    },
    _cleanupOldProcessedItems(processedItems, currentTimestamp) {
      return processedItems
        .map((item) => ({
          // We just need to keep track of the record ID and
          // its creation date.
          id: item.id,
          created_at: item.created_at,
        }))
        .filter((item) => {
          const { created_at: createdAt } = item;
          const createdAtTimestamp = Date.parse(createdAt);
          const cutoffTimestamp = this._addDelayOffset(currentTimestamp);
          return createdAtTimestamp > cutoffTimestamp;
        });
    },
    _makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp) {
      const idList = processedItems
        .map((item) => item.id)
        .map((id) => `'${id}'`)
        .join(", ")
      || "''";
      const startTimestamp = this._addDelayOffset(lowerTimestamp);
      const startDate = this.toISOString(startTimestamp);
      const endDate = this.toISOString(upperTimestamp);
      return `
        contact_id NOT IN (${idList}) AND
        created_at BETWEEN
          TIMESTAMP '${startDate}' AND
          TIMESTAMP '${endDate}'
      `;
    },
    generateMeta(data) {
      const {
        item,
        eventTimestamp: ts,
      } = data;
      const {
        id,
        email,
      } = item;
      const slugifiedEmail = this.slugifyEmail(email);
      const summary = `New contact: ${slugifiedEmail}`;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      // Transform the timer timestamp to milliseconds
      // to be consistent with how Javascript handles timestamps.
      const eventTimestamp = event.timestamp * 1000;

      // Retrieve the current state of the component.
      const {
        processedItems,
        lowerTimestamp,
        upperTimestamp,
      } = this.db.get("state");

      // Search for contacts within a specific timeframe, excluding
      // items that have already been processed.
      const query = this._makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp);
      const {
        result: items,
        contact_count: contactCount,
      } = await this.sendgrid.searchContacts(query);

      // If no contacts have been retrieved via the API,
      // move the time window forward to possibly capture newer contacts.
      if (contactCount === 0) {
        const newState = {
          processedItems: this._cleanupOldProcessedItems(processedItems, lowerTimestamp),
          lowerTimestamp: upperTimestamp,
          upperTimestamp: eventTimestamp,
        };
        this.db.set("state", newState);
        return;
      }

      // We process the searched records from oldest to newest.
      const itemsToProcess = orderBy(items, "created_at");
      itemsToProcess
        .forEach((item) => {
          const meta = this.generateMeta({
            item,
            eventTimestamp,
          });
          this.$emit(item, meta);
        });

      // Use the timestamp of the last processed record as a lower bound for
      // following searches. This bound will be subjected to an offset so in
      // case older records appear in future search results, but have not
      // appeared until now, can be processed. We only adjust it if it means
      // moving forward, not backwards. Otherwise, we might start retrieving
      // older and older records indefinitely (and we're all about *new*
      // records!)
      const newLowerTimestamp = Math.max(
        lowerTimestamp,
        Date.parse(itemsToProcess[0].created_at),
      );

      // If the total contact count is less than 100, it means that during the
      // next iteration the search results count will most likely be less than
      // 50. In that case, if we extend the upper bound of the search time range
      // we might be able to retrieve more records.
      const newUpperTimestamp = contactCount < 100
        ? eventTimestamp
        : upperTimestamp;

      // The list of processed items can grow indefinitely.
      // Since we don't want to keep track of every processed record
      // ever, we need to clean up this list, removing any records
      // that are no longer relevant.
      const newProcessedItems = this._cleanupOldProcessedItems(
        [
          ...processedItems,
          ...itemsToProcess,
        ],
        newLowerTimestamp,
      );

      // Update the state of the component to reflect the computations
      // made above.
      const newState = {
        processedItems: newProcessedItems,
        lowerTimestamp: newLowerTimestamp,
        upperTimestamp: newUpperTimestamp,
      };
      this.db.set("state", newState);
    },
  },
};

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.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About 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.

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:

List Employees with Buddee API on New Contact from Twilio SendGrid API

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