Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: Totango API Reference
Connector package documentation
Table of Contents
- 1. Setting up HTTP Client Totango
- 1.1 Steps
- 2. Subscribing to entities from Totango
- 2.1 Steps
- 2.2 General concept
- 3. Publishing entity to Totango
- 3.1 Steps
- 3.2 General concept
- 4. Subscribing to Totango Search GraphQl API Subscriber
- 4.1 Steps
- 4.2 General concept
1. Setting up HTTP Client Totango
1.1 Steps
- In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
- Select Totango HTTP Client as PlatForm and click next step
- Fill in the Authentication type and Environment Type.
Then complete the field base on the Authentication Type you choose.
(For more information, see Totango Authentication Reference) - Click on “Grant access to Totango” to get the key.
- 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 Totango
2.1 Steps
- Go to Connections → Incoming and create a new incoming configuration and select “Totango Subscriber” as the subscriber.
- Select the entity you want to subscribe to from Totango.
- Add any request parameters needed to subscribe to the entity.
- Select the Totango HTTP Client to use.
- You can optionally add a transformer to transform the request parameters into something you will request from Totango.
- You can also optionally enable pagination to allow Alumio fetches paginated entities.
2.2 General Concept
We follow Totango documentation on building this connector, so you can easily use the connector based on Totango API Reference.
Entity
The entity you want to subscribe to Totango. Please refer to the entities from Totango API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on the Totango API Reference .
Please look at the example below on how to fill path field when subscribing “SCIM - Get a User” entity.
From the end point, we can see that we need to set “service-id” and “user-id” as parameters. That is why we set the “service-id” and “user-id” inside the path key in the Request Parameters.
Alumio will then make a request to Totango with the URL /api/v2/scim/services/271446/Users/321441
- 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 Totango.
3. Publishing Entity to Totango
3.1 Steps
- Go to Connections → Outgoing, create a new outgoing configuration and select “Totango Publisher” as the publisher.
- Select the Action that you want the publisher to perform with the data.
- Select the Totango 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.
Action
Currently, we support HTTP Post method, HTTP Patch method, HTTP Put method and HTTP Delete method on submitting data to Totango.
Entity
We support publishing to most Totango endpoints.
Please refer to Totango API Reference page.
For example, we want to add a new contact. Please select “Post” as the Method and “Touchpoints API - Create New TP” as the entity of the publisher.
Based on the documentation, it requires a post data. That is why we set the post data in the payload key inside Alumio data.
Alumio will send an API request to Totango with URL /api/v3/touchpoints
- 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 Totango.
4. Subscribing to Totango Search GraphQl API Subscriber
4.1 Steps
- Go to Connections → Incoming and create a new incoming configuration and select “Totango Search GraphQl API Subscriber” as the subscriber.
- Select the entity you want to subscribe to from Totango.
- Add any request parameters needed to subscribe to the entity.
- Select the Totango HTTP Client to use.
- You can optionally add a transformer to transform the request parameters into something you will request from Totango.
- You can also optionally enable pagination to allow Alumio fetches paginated entities.
4.2 General Concept
We follow Totango documentation on building this connector, so you can easily use the connector based on Totango Search API Reference.
Entity
The entity you want to subscribe to Totango. Please refer to the entities from Totango Search API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on the Totango Search API Reference .
Please look at the example below on how to fill path field when subscribing “Search API - Search for users” entity.
Based on the documentation, we can see that we need to set the query. That is why we set the query in the Request Parameters.
Alumio will then make a request to Totango with the URL /api/v1/search/users
HTTP Client
The HTTP Client configuration you will use to access Totango.