Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation:
Connector package documentation
Setting up HTTP Client Basecamp 4
Steps
- In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Basecamp 4 HTTP Client as the prototype of the HTTP Client.
- Fill in the Base URI, Client ID, and Client Secret.
- Press “Grant Access to Basecamp 4 ”.
- Press Save Button on Top-Right.
Subscribing to Entities from Basecamp 4
Steps
- Go to Connections → Incoming and create a new incoming configuration and select Basecamp 4 Subscriber as the subscriber.
- Select the Entity you want to subscribe from Basecamp 4.
- Add any request parameters needed to subscribe to the entity.
- You can optionally add a transformer to transform the request parameters into something you need.
- Select the Shipstation HTTP Client to use.
General Concept
We follow Basecamp 4 documentation on building this connector so you can easily use the connector based on Basecamp 4 API Reference.
Entity
It’s the entity you want to subscribe from Basecamp 4. Please refer to the entities in Management APIs from Basecamp 4 API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on Basecamp 4 API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity
That’s why we need to define the id1 property inside path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such a Request Parameters field. (For more examples on how we define the path parameters please see extra Notes below).
/projects/123
Input Transformer
Any transformer’s set here will be executed after the Request Parameters loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity.
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Basecamp 4.
Publishing Entity to Basecamp 4
Steps
- Go to Connections → Outgoing, create a new outgoing configuration and select Basecamp 4 Publisher as the publisher.
- Select the action that you want the publisher to do with the data.
- Select the Basecamp 4 entity you want the data to be published to.
- Select the HTTP Client to use.
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).
Method
Currently we support Post, Put, and Delete methods for submitting data to Basecamp 4 Cloud API.
Entity
We support publishing to most Basecamp 4 endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from Basecamp 4 API Reference page. Based on the documentation, some endpoints may need one or more path parameters.
For endpoints that require object as the request payload, please look at the example below. For example, we want to Create a Project. Please select “POST” as the action and “Create a Project” as the entity of the publisher.
You can put the payload you want to send to Basecamp 4 into payload property in the data. Here is an
example of the Possible Response after Creation.
Alumio will send an API request to Basecamp 4 with URL /projects.json
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Basecamp 4.
Extra Notes
Endpoint Decision
For the Path in the Endpoint the name of the ID is undecided in Documentation
This is from the Documentation :
/buckets/1/chats/2.json
This is what i implement on Endpoint :
"/buckets/{{id1}}/chats/{{id2}}.json"
This also implemented in the Random Number Generated on Docs
/buckets/1/card_tables/lists/3/cards.json
Implemented :
"/buckets/{{id1}}/card_tables/lists/{{id2}}/cards.json"
This works for every endpoint that has a random number in the endpoint
/buckets/1/card_tables/lists/3/cards.json
So if the Endpoints are like this
/buckets/1/3/1/3/cards.json
Implemented :
/buckets/{{id1}}/{{id2}}/{{id3}}/{{id4}}/cards.json