API Clients

For our API integrations, you will have access to our own API client to interact with the service APIs.

General way to acquire the api client is the following:

// const api = libs.<SERVICE_NAME>.get(<INTEGRATION_NAME>)
​
const api = libs.zendesk.get();

Then you will make API calls with the following methods

api.request({
path: ...,
method: ...,
data: ...,
headers: ...,
});
​
// or convenient functions
api.get({
path: ...,
headers: ...,
});
​
api.post({
path: ...,
data: ...,
headers: ...,
});
​
api.put({
path: ...,
data: ...,
headers: ...,
});
​
api.delete({
path: ...,
data: ...,
headers: ...,
});