About the Zoho Desk category

o.plokha · April 17, 2024, 7:30am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Zoho Desk API Reference

Connector package documentation

1. Setting up HTTP Client Zoho Desk

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Zoho Desk HTTP Client as PlatForm and click next step
Fill in the Base URI, Access Token URL, Authorize URL, Client ID, Client Secret and Scopes.
(See Zoho Desk Oauth for more information)
Click on “Grant access to Zoho Desk” and you will be redirected to approve the grant.
You can optionally enable logging of request to get the log of the authentication.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from Zoho Desk

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “Zoho Desk Subscriber” as the subscriber.
Select the entity you want to subscribe to from Zoho Desk.
Add any request parameters needed to subscribe to the entity.
Select the Zoho Desk HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from Zoho Desk.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow Zoho Desk documentation on building this connector, so you can easily use the connector based on Zoho Desk API Reference.

Entity

The entity you want to subscribe to Zoho Desk. Please refer to the entities from Zoho Desk API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Zoho Desk API Reference .

Please look at the example below on how to fill path field when subscribing “Agents - Get agent” entity.

From the end point, we can see that we need to set “agent_id” as parameters. That is why we set the “agent_id” inside the path key in the Request Parameters.

Alumio will then make a request to Zoho Desk with the URL /api/v1/agents/973717000000259144

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0

HTTP Client

The HTTP Client configuration you will use to access Zoho Desk.

3. Publishing Entity to Zoho Desk

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “Zoho Desk Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the Zoho Desk entity you want the data to be published to.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP Post method, HTTP Put method, HTTP Patch method and HTTP Delete method on submitting data to Zoho Desk.

Entity

We support publishing to most Zoho Desk endpoints.
Please refer to Zoho Desk API Reference page.

For example, we want to update an agent. Please select “Patch” as the Method and “Agents - Update agent” as the entity of the publisher.

From the end point, we can see that we need to set “agent_id” as parameters. That is why we set the “agent_id” inside the path key in the data.
Based on the documentation, it requires a request body. That is why we set the request body in the payload key inside Alumio data.

Alumio will send an API request to Zoho Desk with URL /api/v1/agents/973717000000259144

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.