Set Custom Ticket Fields with Zendesk API

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

Trigger workflow on

HTTP requests, schedules and app events

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#

Create a workflow to Set Custom Ticket Fields with the Zendesk API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Set Custom Ticket Fields with Zendesk API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Zendesk

Try it

Set Custom Ticket Fields with Zendesk API on New Submission from Typeform API

Typeform + Zendesk

Try it

Set Custom Ticket Fields with Zendesk API on New Submission (Instant) from Jotform API

Jotform + Zendesk

Try it

Set Custom Ticket Fields with Zendesk API on New Scheduled Tasks from Pipedream API

Pipedream + Zendesk

Try it

Set Custom Ticket Fields with Zendesk API on New Download Counts from npm API

npm + Zendesk

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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
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`

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