# Zendesk

Category: Platforms
|
Runtime: 0.9+
|
Available: Free


# Overview

The zendesk node can be used to connect to Zendesk SaaS platform and create, update and delete tickets.

# Setup

# Prerequisites

For Zendesk node to work properly, you need to have a valid subscription of Zendesk account (opens new window). Ensure to have the necessary connection details and credentials for connecting the platform instance.

# Installation

To install the node from designer:

  1. Go to Add more nodes option on the palette section.
  2. Check for the Zendesk node and click install.
  3. Once installed, the designer is required to be restarted.

To install the node from CLI:

  1. Go to your project workspace where you can see your package.json file.
  2. Run the below give npm command.
    npm i @kumologica/kumologica-contrib-zendesk

# Technical Details

Properties

  • Zendesk Subdomain (Required)
    The subdomain that is associated with your zendesk account.
  • Admin User Email (Required)
    The admin email address associated with your zendesk account that has access to invoke APIs.
  • Security Token (Required)
    Security token associated with your zendesk account for API access.
  • Ticket Requestor Email (Required)
    The email address of the person who is requesting for the service ticket to be created.
  • Subject (Required)
    The subject of the ticket.
  • Message Content (Required)
    The detailed message content for the ticket.
  • Ticket ID (Required)
    The ID of the ticket that needs to be deleted or updated.

Supported Operations

  • Create Ticket
    Create ticket operation will create a new ticket in Zendesk.
  • Delete Ticket
    Delete ticket operation will delete an existing ticket in Zendesk. For this you need the ticket ID.
  • Update Ticket
    Update ticket operation will update an existing ticket in Zendesk. For this you need the ticket ID.

Throws

Zendesk node throws the following exception.

  • ZendeskTimeoutError - When the API invocation does not complete within the execution duration of serverless component.
  • ZendeskAuthenticationError - When not able to authenticate with Zendesk SaaS service with provided Admin User Email and Security Token combination.
  • ZendeskSubdomainUnknownError - When the provided Zendesk subdomain value is invalid.

Returns

On successful execution, a Zendesk ticket will either be created, updated or deleted. Payload will not be overwritten by this node.