Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: Teamleader API Reference
Connector package documentation
Table of Contents
- 1. Setting up HTTP Client Teamleader
- 1.1 Steps
- 2. Subscribing to entities from Teamleader
- 2.1 Steps
- 2.2 General concept
- 3. Publishing entity to Teamleader
- 3.1 Steps
- 3.2 General concept
1. Setting up HTTP Client Teamleader
1.1 Steps
- In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select “Teamleader HTTP Client” as the HTTP Client.
- Fill in the Base URI
- Choose the “Authentication Type”, you can use “Interactive” (Oauth 2 Authentication) or “Bearer Token” for this part.
For more information regarding authentication please refer to this Teamleader API Documentation page. - If you choose “Interactive” then you’ll need to fill Client id and Client secret.
- Press “Grant Access to Teamleader”, it will be redirecting you to Teamleader page.
- Please authorize application by sign in using your credential.
- For “Bearer Token” you’ll need fill the Token.
- You can optionally enable logging of request to get the log of the authentication.
- Save the HTTP Client for use.
2. Subscribing to Entities from Teamleader
2.1 Steps
- Go to Connections → Incoming and create a new incoming configuration and select “Teamleader Subscriber” as the subscriber.
- Select the entity you want to subscribe to from Teamleader.
- Add any request parameters needed to subscribe to the entity.
- You can optionally add a transformer to transform the request parameters into something you will request from Teamleader.
- Select the Teamleader HTTP Client to use.
- You can also optionally enable pagination to allow Alumio fetches paginated entities.
2.2 General Concept
We follow Teamleader documentation on building this connector, so you can easily use the connector based on Teamleader API Reference.
HTTP Client
The HTTP Client configuration you will use to access Teamleader.
Entity
The entity you want to subscribe to Teamleader. Please refer to the entities from Teamleader API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on the Teamleader API Reference .
Please look at the example below on how to fill path field when subscribing “Get details for a single contact by ID” entity.
Based on the documentation, we can see that the end point require “id” as a body. That is why we set the “id” inside the payload key in the Request Parameters.
Alumio will then make a request to Teamleader with the URL /contacts.info
- 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.
3. Publishing Entity to Teamleader
3.1 Steps
- Go to Connections → Outgoing, create a new outgoing configuration and select “Teamleader Publisher” as the publisher.
- Select the Action that you want the publisher to perform with the data.
- Select the Teamleader 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 Create (HTTP POST method) on submitting data to Teamleader.
Entity
We support publishing to most Teamleader endpoints.
Please refer to Teamleader API Reference page.
For example, we want to add a new product. Please select “Create” as the Action and “Add a new contact” as the entity of the publisher.
Based on the documentation, it requires an attributes. That is why we set the attributes inside the payload key in the data.
Alumio will send an API request to Teamleader with URL /contacts.info
- 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 Teamleader.