{"id":23139074,"url":"https://github.com/circuit/circuit-rest-bot","last_synced_at":"2026-05-09T01:02:11.887Z","repository":{"id":40742094,"uuid":"148318104","full_name":"circuit/circuit-REST-bot","owner":"circuit","description":"A bot that uses RESTful API calls to monitor a conversation for circuit.","archived":false,"fork":false,"pushed_at":"2022-12-11T00:58:28.000Z","size":43,"stargazers_count":2,"open_issues_count":3,"forks_count":0,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-02-09T20:33:44.238Z","etag":null,"topics":["api","circuit","circuit-sdk","expr","express","oauth2","rest-api"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/circuit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-11T13:02:46.000Z","updated_at":"2020-09-12T13:13:35.000Z","dependencies_parsed_at":"2023-01-26T12:05:13.441Z","dependency_job_id":null,"html_url":"https://github.com/circuit/circuit-REST-bot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circuit%2Fcircuit-REST-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circuit%2Fcircuit-REST-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circuit%2Fcircuit-REST-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circuit%2Fcircuit-REST-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/circuit","download_url":"https://codeload.github.com/circuit/circuit-REST-bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247157283,"owners_count":20893220,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","circuit","circuit-sdk","expr","express","oauth2","rest-api"],"created_at":"2024-12-17T13:13:12.787Z","updated_at":"2026-05-09T01:02:06.845Z","avatar_url":"https://github.com/circuit.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Circuit RESTful bot GET | POST | Webhook\n==================================\n## Description\nThis is an example bot that uses RESTful API calls to monitor a conversation on circuit.  The bot will log the most recent items in the conversation, post a new item once it is listening, and then log any new items posted in the conversation.\n## Prerequisites\n[![NodeJS](https://img.shields.io/badge/Node.js-6.10.2-brightgreen.svg)](https://nodejs.org) \u003cbr/\u003e\n* Developer account on circuitsandbox.net. Get it for free at [developer registration](https://circuit.github.io/).\n* OAuth 2.0 `client_id` and optionally `client_secret`. Get if for free at [circuit.github.com/oauth](https://circuit.github.com/oauth).\n\n## Dependencies\n\n* [express](https://www.npmjs.com/package/express)\n\n* [node-fetch](https://www.npmjs.com/package/node-fetch)\n* [simple-oauth2](https://www.npmjs.com/package/simple-oauth2)\n\n## REST Reference\nOther examples of RESTful API's with circuit can be found [here](https://circuitsandbox.net/rest/v2/swagger/ui/index.html).\n\n## Usage\n1. Clone the respository.\n2. Run : `$ npm install`.\n3. Rename `config.json.template` to `config.json` after adding your `client_id`, `client_secret`, `url`, and the `port` the bot will run on. The `url` field should refer to the return url the webhook should send data to. Once you have done so all you need to do is run `$ npm start` and the bot will begin.\n* Note: The bot must be a part of the conversation it is listening to.\n4. If you want to host this on your local machine you can use something like [ngrok](https://ngrok.com/) to host the bot. For the webhooks just add the ngrok url as the `url` field in the `config.json` file, make sure you serve the ngrok tunnel on the same port as the bot.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcircuit%2Fcircuit-rest-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcircuit%2Fcircuit-rest-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcircuit%2Fcircuit-rest-bot/lists"}