ballerinax/iris.helpdesk Ballerina library

Overview

This is a generated connector for IRIS Helpdesk API v1.6.4 OpenAPI specification. Connect with the Helpdesk API to work with your ticket data.
Helpdesk tickets are organized by ticket types. Ticket types have properties such as assigned users, expected time to completion (SLA), and visibility to help you segment tickets based on job descriptions. Get detailed helpdesk ticket information, perform updates, and manage attached files with ease by using the Helpdesk API.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

• Create a IRIS CRM account
• Obtain tokens by following this guide

Quickstart

To use the IRIS Helpdesk connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/iris.helpdesk module into the Ballerina project.

import ballerinax/iris.helpdesk;

Step 2: Create a new connector instance

Create a helpdesk:ApiKeysConfig with the API key obtained, and initialize the connector with it.

helpdesk:ApiKeysConfig config = {
    xApiKey: "<API_KEY>"
}
helpdesk:Client baseClient = check new Client(config);

Step 3: Invoke connector operation

1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

   Following is an example on how to get a list of helpdesk tickets using the connector.

   Get a list of helpdesk tickets

   public function main() returns error? {
       helpdesk:InlineResponse20058 response = check baseClient->getHelpdeskTickets();
       log:printInfo(response.toString());
   }

2. Use bal run command to compile and run the Ballerina program.