Run AI Command with HARPA AI API on Ticket Closed (Instant) from Zendesk API

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

Trigger workflow on

Ticket Closed (Instant) from the Zendesk API

Next, do this

Run AI Command with the HARPA AI 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 HARPA AI action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Ticket Closed (Instant) trigger
1. Connect your Zendesk account
2. Optional- Select a Trigger Category ID
3. Optional- Configure Custom Subdomain
4. Optional- Select one or more Fields
5. Optional- Configure JSON Body
Configure the Run AI Command action
1. Connect your HARPA AI account
2. Configure URL
3. Optional- Configure Name
4. Optional- Configure Inputs
5. Optional- Configure Result Param
6. Optional- Configure Node
7. Optional- Configure Timeout
8. Optional- Configure Results Webhook
9. Optional- Configure Connection
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#

Ticket Closed (Instant) on Zendesk

Description:Emit new event when a ticket has changed to closed status

Version:0.2.8

Key:zendesk-ticket-closed

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: "Ticket Closed (Instant)",
  key: "zendesk-ticket-closed",
  type: "source",
  description: "Emit new event when a ticket has changed to closed status",
  version: "0.2.8",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getWebhookName() {
      return "Ticket Closed Webhook";
    },
    getTriggerTitle() {
      return "Ticket Closed Trigger";
    },
    getTriggerConditions() {
      return {
        all: [
          {
            field: "update_type",
            value: "Change",
          },
          {
            field: "status",
            operator: "value",
            value: "closed",
          },
        ],
      };
    },
  },
};

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#

Run AI Command on HARPA AI

Description:Run an AI command. [See the documentation](https://harpa.ai/grid/grid-rest-api-reference#run-ai-command)

Version:0.0.2

Key:harpa_ai-run-ai-command

View on GitHub

Action Code#

import harpaAi from "../../harpa_ai.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "harpa_ai-run-ai-command",
  name: "Run AI Command",
  description: "Run an AI command. [See the documentation](https://harpa.ai/grid/grid-rest-api-reference#run-ai-command)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    harpaAi,
    url: {
      type: "string",
      label: "URL",
      description: "the page to run the AI command over",
    },
    name: {
      type: "string",
      label: "Name",
      description: "A command name to execute such as Summary",
      optional: true,
    },
    inputs: {
      type: "string[]",
      label: "Inputs",
      description: "An array of Strings, each one passed down into command in place of the user input. Inputs are used to bypass waiting for the user input in multi-step commands. For example [ \"REPORT\", \"DONE\" ] for the Summary command.",
      optional: true,
    },
    resultParam: {
      type: "string",
      label: "Result Param",
      description: "A HARPA {{parameter}} to interpret as the command result. By default is set to \"message\" to take the last chat message. Supports dot notation, e.g. \"g.data.email\". Refer to [AI Commands Guide](https://harpa.ai/chatml/overview) for more details.",
      optional: true,
    },
    node: {
      propDefinition: [
        harpaAi,
        "node",
      ],
    },
    timeout: {
      propDefinition: [
        harpaAi,
        "timeout",
      ],
    },
    resultsWebhook: {
      propDefinition: [
        harpaAi,
        "resultsWebhook",
      ],
    },
    connection: {
      type: "string",
      label: "Connection",
      description: "The title or ID of AI connection to use for AI actions. If not specified or connection not found, default connection is used.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.harpaAi.sendAction({
      $,
      data: {
        action: "command",
        url: this.url,
        name: this.name,
        inputs: parseObject(this.inputs),
        resultParam: this.resultParam,
        node: this.node,
        timeout: this.timeout,
        resultsWebhook: this.resultsWebhook,
        connection: this.connection,
      },
    });
    $.export("$summary", `Ran AI command on ${this.url}`);
    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
HARPA AI	`harpaAi`	`app`	This component uses the HARPA AI app.
URL	`url`	`string`	the page to run the AI command over
Name	`name`	`string`	A command name to execute such as Summary
Inputs	`inputs`	`string[]`	An array of Strings, each one passed down into command in place of the user input. Inputs are used to bypass waiting for the user input in multi-step commands. For example [ "REPORT", "DONE" ] for the Summary command.
Result Param	`resultParam`	`string`	A HARPA {{parameter}} to interpret as the command result. By default is set to "message" to take the last chat message. Supports dot notation, e.g. "g.data.email". Refer to AI Commands Guide for more details.
Node	`node`	`string`	A target Node ID which should run the command. If omitted, the first available Node will be used.
Timeout	`timeout`	`string`	Synchronous action execution timeout
Results Webhook	`resultsWebhook`	`string`	An asynchronous webhook URL to send the results to upon completion
Connection	`connection`	`string`	The title or ID of AI connection to use for AI actions. If not specified or connection not found, default connection is used.

Run AI Command with HARPA AI API on Ticket Closed (Instant) from Zendesk API

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