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 Confluence Cloud
Steps
- In Alumio Dashboard, go to Clients > HTTP Clients. Create a new HTTP Client and select Confluence Cloud HTTP Client as the prototype of the HTTP Client.
- Fill in the Base URI, Username, Password.
Subscribing to Entities from Confluence Cloud
Steps
- Go to Connections → Incoming and create a new incoming configuration and select Confluence Cloud Subscriber as the subscriber.
- Select the entity you want to subscribe from Confluence Cloud.
- Add any request parameters needed to subscribe to the entity (optional).
- You can optionally add a transformer to transform the request parameters into something you need.
Select the Confluence Cloud HTTP Client to use. General Concept
We follow Confluence Cloud documentation on building this connector so you can easily use the connector based on Confluence Cloud API Reference.
Entity
It’s the entity you want to subscribe from Confluence Cloud. Please refer to the entities in Management APIs from Confluence Cloud API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on Confluence Cloud 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 id and versionNumber 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 Request Parameters field on coupon entity.
/wiki/rest/api/content/1/version/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 Confluence Cloud.
Publishing Entity to Confluence Cloud
Steps
- Go to Connections → Outgoing, create a new outgoing configuration and select Confluence Cloud Publisher as the publisher.
- Select the action that you want the publisher to do with the data.
- Select the Confluence Cloud 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).
Action
Currently we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method).
Entity
We support publishing to most Confluence Cloud endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from Confluence Cloud 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 Thread. Please select “Create” as the action and “Create new user group” as the entity of the publisher.
You can put the payload you want to send to Confluence Cloud into payload property in the data. Here is an example of the Possible Response after Creation.
Alumio will send an API request to Confluence Cloud with URL /wiki/rest/api/group
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Confluence Cloud.