Circle Interactions to Orbit Workspace
Add your Circle interactions into your Orbit workspace with this community-built integration.
✨This is a community project. The Orbit team does its best to maintain it and keep it up to date with any recent API changes.
We welcome community contributions to make sure that it stays current.
First Time Setup
To set up this integration you will need your Circle API key and your Circle community URL. See the below table for instructions on where to find it, along with your Orbit API credentials.
The application requires the following environment variables:
||Circle API key||Create a new API key in the API section in your User Settings|
||Circle community URL||This is your Circle custom URL, for example:
||API key for Orbit||Found in
||ID for your Orbit workspace||Last part of the Orbit workspace URL, i.e.
Install the package with the following command
$ gem install circle_orbit
bundle install from your terminal.
You can instantiate a client by either passing in the required credentials during instantiation or by providing them in your
Instantiation with credentials:
client = CircleOrbit::Client.new( orbit_api_key: YOUR_API_KEY, orbit_workspace_id: YOUR_ORBIT_WORKSPACE_ID, circle_api_key: YOUR_CIRCLE_API_KEY, circle_url: YOUR_CIRCLE_URL )
Instantiation with credentials in dotenv file:
client = CircleOrbit::Client.new
Post New Spaces Posts to Orbit Workspace
You can use the gem to get new posts in your Circle Spaces and share them as custom activities to your Orbit workspace by using the
#posts method on your
Post New Spaces Comments to Orbit Workspace
You can use the gem to get new comments on posts in your Circle Spaces and share them as custom activities to your Orbit workspace by using the
#posts method on your
You can also use this package with the included CLI. To use the CLI pass in the required environment variables on the command line before invoking the CLI.
To check for new posts:
$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... CIRCLE_API_KEY=... CIRCLE_URL=... bundle exec circle_orbit --check-posts
To check for new comments on posts:
$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... CIRCLE_API_KEY=... CIRCLE_URL=... bundle exec circle_orbit --check-comments
GitHub Actions Automation Setup
⚡ You can set up this integration in a matter of minutes using our GitHub Actions template. It will run regularly to add new activities to your Orbit workspace. All you need is a GitHub account.
We 💜 contributions from everyone! Check out the Contributing Guidelines for more information.
This project is under the MIT License.
Code of Conduct
This project uses the Contributor Code of Conduct. We ask everyone to please adhere by its guidelines.