Skip to content

A bot that uses RESTful API calls to monitor a conversation for circuit.

Notifications You must be signed in to change notification settings

circuit/circuit-REST-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Circuit RESTful bot GET | POST | Webhook

Description

This 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.

Prerequisites

NodeJS

Dependencies

REST Reference

Other examples of RESTful API's with circuit can be found here.

Usage

  1. Clone the respository.
  2. Run : $ npm install.
  3. 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.
  • Note: The bot must be a part of the conversation it is listening to.
  1. If you want to host this on your local machine you can use something like ngrok 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.

About

A bot that uses RESTful API calls to monitor a conversation for circuit.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published