Create Metafield with Shopify (OAuth) API on New Ticket Added to View (Instant) from Zendesk API

Pipedream makes it easy to connect APIs for Shopify (OAuth), Zendesk and 2,500+ other apps remarkably fast.

Trigger workflow on

New Ticket Added to View (Instant) from the Zendesk API

Next, do this

Create Metafield with the Shopify (OAuth) 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 Zendesk trigger and Shopify (OAuth) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Ticket Added to View (Instant) trigger
1. Connect your Zendesk account
2. Select a Trigger Category ID
3. Optional- Configure Custom Subdomain
4. Optional- Select one or more Fields
5. Optional- Configure JSON Body
6. Select a View ID
Configure the Create Metafield action
1. Connect your Shopify (OAuth) account
2. Select a Resource Type
3. Configure Name
4. Configure Namespace
5. Configure Key
6. Select a Type
7. Optional- Configure Pin
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 Ticket Added to View (Instant) on Zendesk

Description:Emit new event when a ticket is added to the specified view

Version:0.0.2

Key:zendesk-ticket-added-to-view

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.

Trigger Code#

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

export default {
  ...common,
  key: "zendesk-ticket-added-to-view",
  name: "New Ticket Added to View (Instant)",
  description: "Emit new event when a ticket is added to the specified view",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    viewId: {
      propDefinition: [
        common.props.app,
        "viewId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getWebhookName() {
      return "Ticket Added To View Webhook";
    },
    getTriggerTitle() {
      return "Ticket Added To View Trigger";
    },
    getTriggerConditions() {
      return {
        any: [
          {
            field: "update_type",
            value: "Change",
          },
          {
            field: "update_type",
            value: "Create",
          },
        ],
      };
    },
    async isRelevant(payload) {
      const { tickets } = await this.app.listTicketsInView({
        viewId: this.viewId,
      });
      const foundTicket = tickets.find(({ id }) => id == payload.ticketId);
      return foundTicket;
    },
  },
};

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
Zendesk	`app`	`app`	This component uses the Zendesk app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Trigger Category ID	`categoryId`	`string`	Select a value from the drop down menu.
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`
Fields	`fields`	`string[]`	Select a value from the drop down menu.
JSON Body	`jsonBody`	`string`	Custom JSON Body of the incoming payload. Setting `jsonBody` will overwrite the `fields` prop
View ID	`viewId`	`string`	Select a value from the drop down menu.

Trigger 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

About Zendesk#

Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.

Action#

Create Metafield on Shopify (OAuth)

Description:Creates a metafield belonging to a resource. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/metafieldDefinitionCreate)

Version:0.0.11

Key:shopify-create-metafield

View on GitHub

Shopify (OAuth) Overview#

Shopify provides a powerful API that enables developers to build a wide range
of applications and tools for merchants. Some examples of what you can build
using the Shopify API include:

Merchant tools: tools that help merchants manage their stores, such as order
management, product administration, and reporting
E-commerce applications: applications that enable merchants to sell their
products online, such as shopping carts, product catalogs, and order
management
Integration tools: tools that helps integrate Shopify with other systems,
such as accounting, inventory, and shipping

Action Code#

import shopify from "../../shopify.app.mjs";
import constants from "../common/constants.mjs";

export default {
  key: "shopify-create-metafield",
  name: "Create Metafield",
  description: "Creates a metafield belonging to a resource. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/metafieldDefinitionCreate)",
  version: "0.0.11",
  type: "action",
  props: {
    shopify,
    ownerResource: {
      type: "string",
      label: "Resource Type",
      description: "Filter by the resource type on which the metafield is attached to",
      options: constants.RESOURCE_TYPES.map((type) => ({
        ...type,
        value: type.value.toUpperCase(),
      })),
    },
    name: {
      type: "string",
      label: "Name",
      description: "The human-readable name for the metafield definition",
    },
    namespace: {
      type: "string",
      label: "Namespace",
      description: "A container for a group of metafields. Grouping metafields within a namespace prevents your metafields from conflicting with other metafields with the same key name. Must have between 3-255 characters.",
    },
    key: {
      type: "string",
      label: "Key",
      description: "The key of the metafield. Keys can be up to 64 characters long and can contain alphanumeric characters, hyphens, underscores, and periods.",
    },
    type: {
      type: "string",
      label: "Type",
      description: "The type of data that the metafield stores in the `value` field. Refer to the list of [supported types](https://shopify.dev/apps/custom-data/metafields/types).",
      options: Object.keys(constants.METAFIELD_TYPES),
    },
    pin: {
      type: "boolean",
      label: "Pin",
      description: "Whether to pin the metafield definition",
      default: false,
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.shopify.createMetafield({
      definition: {
        ownerType: this.ownerResource,
        name: this.name,
        namespace: this.namespace,
        key: this.key,
        type: this.type,
        pin: this.pin,
      },
    });
    if (response.metafieldDefinitionCreate.userErrors.length > 0) {
      throw new Error(response.metafieldDefinitionCreate.userErrors[0].message);
    }
    $.export("$summary", `Created metafield ${this.name} for object type ${this.type}`);
    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
Shopify (OAuth)	`shopify`	`app`	This component uses the Shopify (OAuth) app.
Resource Type	`ownerResource`	`string`	Select a value from the drop down menu:`{ "label": "Blog", "value": "BLOG" }{ "label": "Collection", "value": "COLLECTION" }{ "label": "Page", "value": "PAGE" }{ "label": "Product", "value": "PRODUCT" }{ "label": "Product Variant", "value": "VARIANTS" }{ "label": "Article", "value": "ARTICLE" }`
Name	`name`	`string`	The human-readable name for the metafield definition
Namespace	`namespace`	`string`	A container for a group of metafields. Grouping metafields within a namespace prevents your metafields from conflicting with other metafields with the same key name. Must have between 3-255 characters.
Key	`key`	`string`	The key of the metafield. Keys can be up to 64 characters long and can contain alphanumeric characters, hyphens, underscores, and periods.
Type	`type`	`string`	Select a value from the drop down menu:`booleancollection_referencecolordatedate_timedimensionfile_referencejsonmetaobject_referencemixed_referencemoneymulti_line_text_fieldnumber_decimalnumber_integerpage_referenceproduct_referenceratingsingle_line_text_fieldurlvariant_referencevolumeweightlist.collection_referencelist.colorlist.datelist.date_timelist.dimensionlist.file_referencelist.metaobject_referencelist.mixed_referencelist.number_integerlist.number_decimallist.page_referencelist.product_referencelist.ratinglist.single_line_text_fieldlist.urllist.variant_referencelist.volumelist.weight`
Pin	`pin`	`boolean`	Whether to pin the metafield definition

Action Authentication#

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

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

Create Metafield with Shopify (OAuth) API on New Ticket Added to View (Instant) from Zendesk API

Pipedream makes it easy to connect APIs for Shopify (OAuth), Zendesk and 2,500+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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