Delete Ticket with Zendesk API on New Webhook Message (Instant) from Codat API

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

Trigger workflow on

New Webhook Message (Instant) from the Codat API

Next, do this

Delete Ticket 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 Codat 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 Webhook Message (Instant) trigger
1. Connect your Codat account
2. Select one or more Event Type
3. Select a Company ID
Configure the Delete Ticket action
1. Connect your Zendesk account
2. Select a Ticket ID
3. 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 Webhook Message (Instant) on Codat

Description:Emit new event when a specified event type is produced by Codat. [See the documentation](https://docs.codat.io/platform-api#/operations/create-webhook-consumer)

Version:0.0.1

Key:codat-new-webhook-message-instant

View on GitHub

Codat Overview#

The Codat API provides a way to seamlessly integrate and automate financial data processes for businesses. With Codat, you can connect to accounting software, extract company financials, and reconcile transactions in real-time. Whether it's for pulling recent invoices, syncing payment information, or consolidating financial reports, Codat's API acts as a bridge between various accounting platforms and your applications, enabling more efficient financial operations and decision-making.

Trigger Code#

import codat from "../../codat.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "codat-new-webhook-message-instant",
  name: "New Webhook Message (Instant)",
  description: "Emit new event when a specified event type is produced by Codat. [See the documentation](https://docs.codat.io/platform-api#/operations/create-webhook-consumer)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    codat,
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    eventTypes: {
      propDefinition: [
        codat,
        "eventTypes",
      ],
    },
    companyId: {
      propDefinition: [
        codat,
        "companyId",
      ],
    },
  },
  hooks: {
    async activate() {
      const data = {
        url: this.http.endpoint,
        eventTypes: this.eventTypes,
      };
      if (this.companyId) {
        data.companyId = this.companyId;
      }
      const { id } = await this.codat.createWebhook({
        data,
      });
      this._setHookId(id);
    },
    async deactivate() {
      const hookId = this._getHookId();
      if (hookId) {
        await this.codat.deleteWebhook({
          hookId,
        });
      }
    },
  },
  methods: {
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    generateMeta(body) {
      return {
        id: body.AlertId,
        summary: body.Message,
        ts: Date.now(),
      };
    },
  },
  async run({ body }) {
    this.http.respond({
      status: 200,
    });
    const meta = this.generateMeta(body);
    this.$emit(body, meta);
  },
  sampleEmit,
};

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
Codat	`codat`	`app`	This component uses the Codat 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.
Event Type	`eventTypes`	`string[]`	Select a value from the drop down menu:`{ "value": "AccountCategoriesUpdated", "label": "Triggered anytime a company's accounts are categorized. This can be when Codat updates the suggested category fields or a user updates the confirmed category fields." }{ "value": "bankFeeds.sourceAccount.connected", "label": "Indicates a bank feed source account has changed to a status of connected." }{ "value": "bankFeeds.sourceAccount.disconnected", "label": "Indicates a bank feed source account has changed to a status of disconnected." }{ "value": "ClientRateLimitReached", "label": "Triggered when the number of requests to Codat's API from the client exceeds the current quota." }{ "value": "ClientRateLimitReset", "label": "Triggered when the rate limit quota has reset for the client, and more requests to the API are available." }{ "value": "DataConnectionStatusChanged", "label": "Triggered when a data connection status of a specific company changes." }{ "value": "DataSyncCompleted", "label": " Generated for each dataType to indicate that data synchronization is successfully completed for that specific data type." }{ "value": "DataSyncStatusChangedToError", "label": "Triggered when the synchronization of a dataset fails." }{ "value": "DatasetDataChanged", "label": " Generated for each dataType to indicate that dataset synchronization has completed and updated Codat's data cache through the creation of new records or a change to existing records." }{ "value": "NewCompanySynchronized", "label": "Triggered when initial syncs are complete for all data types queued for a newly connected company, and at least one of those syncs is successful." }{ "value": "PushOperationStatusChanged", "label": "Indicates that a create, update, or delete operation's status has changed. You can learn more about push operations at Codat." }{ "value": "PushOperationTimedOut", "label": "Indicates that a create, update, or delete operation has timed out. You can learn more about timeouts for push operations at Codat." }{ "value": "SyncCompleted", "label": "Triggered anytime an expense sync completes. Used for Sync for Expenses only." }{ "value": "SyncConnectionDeleted", "label": "Indicates a Sync for Commerce connection has been deleted. Used for Sync for Commerce only." }{ "value": "SyncFailed", "label": "Indicates a failure occurred during an expense sync. Used for Sync for Expenses only." }`
Company ID	`companyId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To retrieve your API keys and Authorization Header,

Navigate to your Codat account and sign in
Go to “Developers" > "API Keys"

About Codat#

Codat's business data APIs connect banks and fintechs to all of the financial systems their customers use.

Action#

Delete Ticket on Zendesk

Description:Deletes a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#delete-ticket).

Version:0.1.2

Key:zendesk-delete-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.

Action Code#

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

export default {
  key: "zendesk-delete-ticket",
  name: "Delete Ticket",
  description: "Deletes a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#delete-ticket).",
  type: "action",
  version: "0.1.2",
  props: {
    app,
    ticketId: {
      propDefinition: [
        app,
        "ticketId",
      ],
    },
    customSubdomain: {
      propDefinition: [
        app,
        "customSubdomain",
      ],
    },
  },
  methods: {
    deleteTicket({
      ticketId, ...args
    } = {}) {
      return this.app.delete({
        path: `/tickets/${ticketId}`,
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      ticketId,
      customSubdomain,
    } = this;

    await this.deleteTicket({
      step,
      ticketId,
      customSubdomain,
    });

    step.export("$summary", "Successfully deleted ticket");

    return true;
  },
};

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