Add Ticket Tags with Zendesk API on Employee Terminated from Drata API

Pipedream makes it easy to connect APIs for Zendesk, Drata and 2,900+ other apps remarkably fast.

Trigger workflow on

Employee Terminated from the Drata API

Next, do this

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

Select this integration
Configure the Employee Terminated trigger
1. Connect your Drata account
2. Configure timer
Configure the Add Ticket Tags action
1. Connect your Zendesk account
2. Select a Ticket ID
3. Optional- Configure Tags
4. Optional- Configure Custom Subdomain
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#

Employee Terminated on Drata

Description:Emit a new event when an employee is terminated. [See the documentation](https://developers.drata.com/docs/openapi/reference/operation/PersonnelPublicController_listPersonnel/).

Version:0.0.3

Key:drata-terminated-employee

View on GitHub

Drata Overview#

Drata is a compliance automation platform. Drata’s platform is built by compliance and security experts so you don’t have to be one. With 75+ native integrations, you can easily connect your tech stack and automate evidence collection and testing.

Pipedream customers get 25% off Drata, with implementation fees waived. Visit https://drata.com/partner/pipedream for more information.

Trigger Code#

import drata from "../../drata.app.mjs";
import constants from "../../common/constants.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

const docsLink = "https://developers.drata.com/docs/openapi/reference/operation/PersonnelPublicController_listPersonnel/";

export default {
  key: "drata-terminated-employee",
  name: "Employee Terminated",
  description: `Emit a new event when an employee is terminated. [See the documentation](${docsLink}).`,
  type: "source",
  version: "0.0.3",
  dedupe: "unique",
  props: {
    drata,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  hooks: {
    async deploy() {
      const { data: lastCurrentEmployees } = await this.drata.listPersonnel({
        paginate: true,
        params: {
          sort: constants.SORT_CRITERIA.START_DATE, // this endpoint does not support sorting by creation date
          employmentStatuses: [
            "CURRENT_EMPLOYEE",
            "CURRENT_CONTRACTOR",
          ],
        },
      });

      this._setLastCurrentEmployees(lastCurrentEmployees.map((personnel) => personnel.id));

      const response = await this.drata.listPersonnel({
        params: {
          limit: constants.DEPLOY_LIMIT,
          sort: constants.SORT_CRITERIA.SEPARATION_DATE,
          sortDir: "DESC",
          employmentStatuses: [
            "FORMER_EMPLOYEE",
            "FORMER_CONTRACTOR",
            "SPECIAL_FORMER_EMPLOYEE",
            "SPECIAL_FORMER_CONTRACTOR",
          ],
        },
      });

      for (const personnel of response.data.reverse()) {
        this.$emit(personnel, {
          id: personnel.id,
          summary: `Historical terminated employee added event: ${this.drata.getPersonnelName(personnel)}`,
          ts: personnel.updatedAt,
        });
      }
    },
  },
  methods: {
    _getLastCurrentEmployees() {
      return new Set(this.db.get("lastCurrentEmployees"));
    },
    _setLastCurrentEmployees(lastCurrentEmployees) {
      this.db.set("lastCurrentEmployees", Array.from(lastCurrentEmployees));
    },
    getDifference(setA, setB) {
      return new Set(
        Array.from(setA).filter((element) => !setB.has(element)),
      );
    },
    async getTerminatedEmployees(terminatedEmployees) {
      if (!Array.isArray(terminatedEmployees)) {
        terminatedEmployees = Array.from(terminatedEmployees);
      }
      const employees = await Promise.all(
        terminatedEmployees.map((id) => this.drata.getPersonnelById({
          id,
        })),
      );
      return employees.filter(({ employmentStatus }) => employmentStatus.includes("FORMER"));
    },
    addNewEmployees(newEmployees, lastCurrentEmployees) {
      newEmployees.forEach((id) => lastCurrentEmployees.add(id));
    },
  },
  async run() {
    const lastCurrentEmployees = this._getLastCurrentEmployees();

    const response = await this.drata.listPersonnel({
      paginate: true,
      params: {
        limit: constants.PAGINATION_LIMIT,
        sort: constants.SORT_CRITERIA.START_DATE,
        employmentStatuses: [
          "CURRENT_EMPLOYEE",
          "CURRENT_CONTRACTOR",
        ],
      },
    });

    const currentEmployees = new Set(response.data.map((personnel) => personnel.id));
    const terminatedEmployees = this.getDifference(lastCurrentEmployees, currentEmployees);
    const newEmployees = this.getDifference(currentEmployees, lastCurrentEmployees);

    const terminated = await this.getTerminatedEmployees(Array.from(terminatedEmployees));
    for (const employee of terminated) {
      lastCurrentEmployees.delete(employee.id);
      this.$emit(employee, {
        id: employee.id,
        summary: `Employee terminated: ${this.drata.getPersonnelName(employee)}`,
        ts: employee.updatedAt,
      });
    }

    this.addNewEmployees(newEmployees, lastCurrentEmployees);
    this._setLastCurrentEmployees(lastCurrentEmployees);
  },
};

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
Drata	`drata`	`app`	This component uses the Drata app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

Make sure you're logged into the Drata UI, then see these docs to create a Drata API key. Enter it below.

About Drata#

Drata automates your compliance journey from start to audit-ready and beyond and provides support from the security and compliance experts who built it.

Action#

Add Ticket Tags on Zendesk

Description:Add tags to a ticket (appends to existing tags). [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/#add-tags).

Version:0.0.5

Key:zendesk-add-ticket-tags

View on GitHub

Zendesk Overview#

The Zendesk API enables seamless integration of Zendesk's customer service platform with your existing business processes and third-party applications. By leveraging this API with Pipedream, you can automate ticket tracking, sync customer data, escalate issues, and streamline communication across multiple channels. This can significantly increase efficiency, accelerate response times, and enhance the overall customer experience. Automations can range from simple notifications to complex workflows involving data transformation and multi-step actions across various services.

Action Code#

import app from "../../zendesk.app.mjs";

export default {
  key: "zendesk-add-ticket-tags",
  name: "Add Ticket Tags",
  description: "Add tags to a ticket (appends to existing tags). [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/#add-tags).",
  type: "action",
  version: "0.0.5",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    ticketId: {
      propDefinition: [
        app,
        "ticketId",
      ],
    },
    ticketTags: {
      propDefinition: [
        app,
        "ticketTags",
      ],
      description: "Array of tags to add to the ticket. These will be appended to any existing tags.",
    },
    customSubdomain: {
      propDefinition: [
        app,
        "customSubdomain",
      ],
    },
  },
  async run({ $: step }) {
    const {
      ticketId,
      ticketTags,
      customSubdomain,
    } = this;

    const response = await this.app.addTicketTags({
      step,
      ticketId,
      tags: ticketTags,
      customSubdomain,
    });

    step.export("$summary", `Successfully added ${ticketTags.length} tag(s) to ticket ${ticketId}`);
    return response;
  },
};

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
Zendesk	`app`	`app`	This component uses the Zendesk app.
Ticket ID	`ticketId`	`string`	Select a value from the drop down menu.
Tags	`ticketTags`	`string[]`	Array of tags to add to the ticket. These will be appended to any existing tags.
Custom Subdomain	`customSubdomain`	`string`	For Enterprise Zendesk accounts: optionally specify the subdomain to use. This will override the subdomain that was provided when connecting your Zendesk account to Pipedream. For example, if you Zendesk URL is https://examplehelp.zendesk.com, your subdomain is `examplehelp`

Action Authentication#

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

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

triggers:writewebhooks:writereadtickets:writetickets:readusers:writeorganizations:readorganizations:write

Add Ticket Tags with Zendesk API on Employee Terminated from Drata API

Pipedream makes it easy to connect APIs for Zendesk, Drata and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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