Set Custom Ticket Fields with Zendesk API on New Invitee Created from Calendly API

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

Trigger workflow on

New Invitee Created from the Calendly API

Next, do this

Set Custom Ticket Fields 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 Calendly 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 New Invitee Created trigger
1. Connect your Calendly account
2. Select a Scope
Configure the Set Custom Ticket Fields action
1. Connect your Zendesk account
2. Select a Ticket ID
3. Configure Custom Fields
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#

New Invitee Created on Calendly

Description:Emit new event when a new event is scheduled.

Version:0.0.5

Key:calendly_v2-invitee-created

View on GitHub

Calendly Overview#

The Calendly API lets you craft bespoke scheduling experiences within your apps or automate repetitive tasks involving your calendar. With this API, you can read event types, set up webhooks for new events, list invitees, or create and cancel invitation links programmatically. Pipedream's serverless platform takes the heavy lifting out of integrating Calendly with hundreds of other apps, enabling you to focus on creating workflows that save time, enhance productivity, and eliminate scheduling errors.

Trigger Code#

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

export default {
  ...common,
  key: "calendly_v2-invitee-created",
  name: "New Invitee Created",
  description: "Emit new event when a new event is scheduled.",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    scope: {
      propDefinition: [
        common.props.app,
        "scope",
      ],
    },
  },
  methods: {
    ...common.methods,
    getEvent() {
      return [
        "invitee.created",
      ];
    },
    getScope() {
      return this.scope;
    },
    generateMeta(body) {
      return {
        id: `${body.event}-${body.payload.created_at}`,
        summary: `${body.payload.name} - ${body.event}`,
        ts: Date.now(),
      };
    },
  },
};

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
Calendly	`app`	`app`	This component uses the Calendly app.
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.
Scope	`scope`	`string`	Select a value from the drop down menu:`userorganization`

Trigger Authentication#

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

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

About Calendly#

Schedule meetings without the hassle. Never get double booked. Calendly works with your calendar to automate appointment scheduling.

Action#

Set Custom Ticket Fields on Zendesk

Description:Sets one or more custom field values on a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).

Version:0.0.2

Key:zendesk-set-custom-ticket-fields

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";
import { parseObject } from "../../common/utils.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "zendesk-set-custom-ticket-fields",
  name: "Set Custom Ticket Fields",
  description: "Sets one or more custom field values on a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).",
  type: "action",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    ticketId: {
      propDefinition: [
        app,
        "ticketId",
      ],
    },
    customFields: {
      type: "string[]",
      label: "Custom Fields",
      description: "Array of custom field objects. Each item should be formatted as `{\"id\": \"field_id\", \"value\": \"field_value\"}`. Example: `{\"id\": \"23129751115165\", \"value\": \"ABCDE\"}`",
    },
    customSubdomain: {
      propDefinition: [
        app,
        "customSubdomain",
      ],
    },
  },
  methods: {
    updateTicket({
      ticketId, ...args
    } = {}) {
      return this.app.update({
        path: `/tickets/${ticketId}`,
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      ticketId,
      customFields,
      customSubdomain,
    } = this;

    // Parse custom fields from string array to objects
    const parsedCustomFields = parseObject(customFields);

    if (!Array.isArray(parsedCustomFields)) {
      throw new ConfigurationError("Custom Fields must be an array of custom field objects");
    }

    // Validate custom fields structure
    parsedCustomFields.forEach((field, index) => {
      if (!field.id) {
        throw new ConfigurationError(`Custom field at index ${index} is missing required "id" property`);
      }
      if (field.value === undefined) {
        throw new ConfigurationError(`Custom field at index ${index} is missing required "value" property`);
      }
    });

    const response = await this.updateTicket({
      step,
      ticketId,
      customSubdomain,
      data: {
        ticket: {
          custom_fields: parsedCustomFields,
        },
      },
    });

    step.export("$summary", `Successfully updated ${parsedCustomFields.length} custom field(s) on ticket ${response.ticket.id}`);

    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.
Custom Fields	`customFields`	`string[]`	Array of custom field objects. Each item should be formatted as `{"id": "field_id", "value": "field_value"}`. Example: `{"id": "23129751115165", "value": "ABCDE"}`
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

Set Custom Ticket Fields with Zendesk API on New Invitee Created from Calendly API

Pipedream makes it easy to connect APIs for Zendesk, Calendly 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