About the Zendesk category

Alumio_Bot · September 21, 2022, 11:10am

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

Extra information

System documentation: Zendesk API Reference

Connector package documentation

1. Setting up HTTP Client Zendesk

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Zendesk HTTP Client as PlatForm and click next step
Fill in the Base URI Client ID and authentication based on your selected type.
(For more information, see Zendesk Postman Reference)
For Oauth only, please click on “Grant access to Zendesk” and you will be provided with the key to continue.
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 Zendesk

2.1 Steps

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

2.2 General Concept

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

Entity

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

Request Parameters

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

Please look at the example below on how to fill path field when subscribing “List Ticket By Organization ID” entity.

Based on the documentation, we can see that the end point require “organization_id” as a parameter. That is why we set the “organization_id” inside the path key in the Request Parameters.

Alumio will then make a request to Zendesk with the URL /api/v2/organizations/123/tickets

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.

HTTP Client

The HTTP Client configuration you will use to access Zendesk.

3. Publishing Entity to Zendesk

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “Zendesk Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the Zendesk 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 Zendesk.

Entity

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

For example, we want to create many tickets. Please select “POST” as the Method and “Create Many Tickets” as the entity of the publisher.

Based on the documentation, it requires a body request. That is why we set the body request inside the payload key in the data.

Alumio will send an API request to Zendesk with URL /api/v2/tickets/create_many

Another example is when we want to delete a ticket. Please select “DELETE” as the Method and “Delete Ticket” as the entity of the publisher.

Based on the documentation, we can see that the end point require “ticket_id” as a parameter. That is why we set the “ticket_id” inside the path key in the Request Parameters.

Alumio will then make a request to Zendesk with the URL /api/v2/tickets/123

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.