Create Client with Clientary API on New Ticket (Instant) from Zendesk API

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

Trigger workflow on

New Ticket (Instant) from the Zendesk API

Next, do this

Create Client with the Clientary 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 Clientary 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 (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
Configure the Create Client action
1. Connect your Clientary account
2. Configure Client Name
3. Optional- Configure Number
4. Optional- Configure Description
5. Optional- Configure Web Site
6. Optional- Configure Country
7. Optional- Configure State
8. Optional- Configure City
9. Optional- Configure Address
10. Optional- Configure Zip
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 (Instant) on Zendesk

Description:Emit new event when a ticket is created

Version:0.2.2

Key:zendesk-new-ticket

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,
  name: "New Ticket (Instant)",
  key: "zendesk-new-ticket",
  type: "source",
  description: "Emit new event when a ticket is created",
  version: "0.2.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getWebhookName() {
      return "New Ticket Webhook";
    },
    getTriggerTitle() {
      return "New Ticket Trigger";
    },
    getTriggerConditions() {
      return {
        all: [
          {
            field: "update_type",
            value: "Create",
          },
        ],
      };
    },
  },
};

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

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 Client on Clientary

Description:Creates a new client. [See docs here](https://www.clientary.com/api/clients)

Version:0.0.1

Key:clientary-create-client

View on GitHub

Clientary Overview#

The Clientary API allows you to automate and integrate Clientary's project management, time tracking, and invoicing functionalities within Pipedream. By leveraging this API, you can create custom workflows to streamline operations, such as syncing new invoices with accounting software, triggering notifications based on project updates, or automating time tracking entries. Pipedream acts as the glue, enabling you to connect Clientary with hundreds of other apps to create sophisticated, serverless workflows tailored to your business needs.

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/clientary.app.mjs";
export default defineAction({
    key: "clientary-create-client",
    version: "0.0.1",
    name: "Create Client",
    description: "Creates a new client. [See docs here](https://www.clientary.com/api/clients)",
    type: "action",
    props: {
        app,
        name: {
            type: "string",
            label: "Client Name",
            description: "Client name",
        },
        number: {
            type: "string",
            label: "Number",
            description: "Client number. Must be unique, e.g. `101`",
            optional: true,
        },
        description: {
            type: "string",
            label: "Description",
            description: "Client description",
            optional: true,
        },
        website: {
            type: "string",
            label: "Web Site",
            description: "Client Web Site",
            optional: true,
        },
        country: {
            type: "string",
            label: "Country",
            description: "The country where the client is registered",
            optional: true,
        },
        state: {
            type: "string",
            label: "State",
            description: "The state where the client is registered",
            optional: true,
        },
        city: {
            type: "string",
            label: "City",
            description: "The city where the client is registered",
            optional: true,
        },
        address: {
            type: "string",
            label: "Address",
            description: "The address where the client is registered",
            optional: true,
        },
        zip: {
            type: "string",
            label: "Zip",
            description: "The zip code where the client is registered",
            optional: true,
        },
    },
    async run({ $ }) {
        const response = await this.app.getRequestMethod("createClient")({
            $,
            data: {
                name: this.name,
                number: this.number,
                description: this.description,
                website: this.website,
                country: this.country,
                state: this.state,
                city: this.city,
                address: this.address,
                zip: this.zip,
            },
        });
        $.export("$summary", `Successfully created a client (ID: ${response.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
Clientary	`app`	`app`	This component uses the Clientary app.
Client Name	`name`	`string`	Client name
Number	`number`	`string`	Client number. Must be unique, e.g. `101`
Description	`description`	`string`	Client description
Web Site	`website`	`string`	Client Web Site
Country	`country`	`string`	The country where the client is registered
State	`state`	`string`	The state where the client is registered
City	`city`	`string`	The city where the client is registered
Address	`address`	`string`	The address where the client is registered
Zip	`zip`	`string`	The zip code where the client is registered

Action Authentication#

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

To connect your Clientary account with Pipedream,

Find your Clientary domain and paste it below. If the full URL is https://mygreatcompany.clientary.com, your domain is mygreatcompany.
Go to your user profile page in Clientary. You can find this on the upper right corner after logging in.
Click to "Generate API Token" to generate a unique token. Copy and paste that token below.

Create Client with Clientary API on New Ticket (Instant) from Zendesk API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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