{"id":18782993,"url":"https://github.com/webex/eurl","last_synced_at":"2025-07-05T19:09:42.294Z","repository":{"id":47359813,"uuid":"295791640","full_name":"webex/eurl","owner":"webex","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-19T03:10:42.000Z","size":1448,"stargazers_count":4,"open_issues_count":15,"forks_count":6,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-13T12:09:15.304Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/webex.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-15T16:47:53.000Z","updated_at":"2022-12-14T21:47:38.000Z","dependencies_parsed_at":"2024-11-07T20:40:13.610Z","dependency_job_id":null,"html_url":"https://github.com/webex/eurl","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/webex%2Feurl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webex%2Feurl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webex%2Feurl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webex%2Feurl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webex","download_url":"https://codeload.github.com/webex/eurl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248710448,"owners_count":21149190,"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":[],"created_at":"2024-11-07T20:37:48.313Z","updated_at":"2025-04-13T12:09:21.165Z","avatar_url":"https://github.com/webex.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Public Spaces for Cisco Webex Teams\n\nInstallation\n------------\n\n``` bash\n$ git clone https://github.com/webex/eurl.git\n$ npm install\n```\n\nAfter it's installed you need to configure it.\n\nConfiguration\n------------\n\nSome environment variables must be set for this to work. You can create a .env file or set environment variables based on the details below.\n\nIf using a .env file, it must be in the same directory as index.js.\n\n``` bash\n#Specify the port for epxress to listen on [optional; default = 3000]\n#PORT=3000\n\n#Specify the port for admin apis to listen on [optional]\n#PORT=3001\n\n#If a reverse web proxy is in front of express set to \"true\" [optional; default = false]\n#REVERSE_PROXY=\"true\"\n\n#This is the URL that users will visit to join spaces [required]\nBASE_URL=\"https://\u003chostname\u003e/\u003cpath\u003e\"\n\n#The Mongo DB URI to use to store data on public spaces and sessions [required]\nMONGO_URI=\"mongodb://localhost/publicspaces-webexteams\"\n\n#The access token for the Cisco Webex Teams bot [required]\n#Note: The ciscospark package requires this env variable to be set. That package hasn't changed naming to Webex Teams yet.\nCISCOSPARK_ACCESS_TOKEN=\"\u003cprovided by https://developer.webex.com/\u003e\"\n\n#The Cisco Webex Teams Space ID (roomId) that will have errors posted. Required to test existance of accounts in Cisco Webex Teams [optional]\n#WEBEXTEAMS_ADMIN_SPACE_ID=\n\n#Cisco Webex Teams Webhook secret to verify authenticity of data [optional]\n#WEBEXTEAMS_WEBHOOK_SECRET=\n\n#Messages to send to Cisco Webex Teams to avoid hit ratelimiting [optional; default = 4]\n#Note: Currently only used during startup to build membership cache\n#WEBEXTEAMS_MESSAGES_PER_SECOND=4\n\n#The URL to the source code repository for this bot [optional; default = https://github.com/birdietiger/publicspaces-webexteams]\n#SOURCE_URL=\n\n#The Cisco Webex Teams Space ID (roomId) that users can join to get support [optional]\n#WEBEXTEAMS_SUPPORT_SPACE_ID=\n\n#Restrict the user domains the bot will respond to and add to spaces. If set, disables \"internal\" setting in spaces [optional]\n#PERMIT_DOMAINS=\n\n#Set description used for website listing and messaging help [optional]\n#DESCRIPTION=\n\n#Allows users of website to request support via email [optional]\n#SUPPORT_EMAIL=\n\n#Where to store logs in machine-readable format [optional]\n#LOG_FILE=\n\n#Set log level [optional; default = info]\n#\"error\", \"warn\", \"info\", \"verbose\", \"debug\", or \"silly\"\n#LOG_LEVEL=\"debug\"\n```\n\nCisco Webex Teams Webhooks\n------------\n\nFor the bot to receive all notifications from Cisco Webex Teams, you must manually create a [webhook](https://developer.webex.com/webhooks-explained.html).\n\nWebhooks are expected at `https://\u003chostname\u003e/\u003cpath\u003e/api/webhooks`. You'll need to use the same secret for all webhooks and set it in the `WEBEXTEAMS_WEBHOOK_SECRET` environment variable.\n\nYou'll need to create the following webhooks:\n\n``` json\n{\n  \"name\": \"publicspaces messages:created\",\n  \"targetUrl\": \"https://\u003chostname\u003e/\u003cpath\u003e/api/webhooks\",\n  \"resource\": \"messages\",\n  \"event\": \"created\",\n  \"secret\": \"\u003cWEBEXTEAMS_WEBHOOK_SECRET environment variable\u003e\"\n}\n```\n\n``` json\n{\n  \"name\": \"publicspaces rooms:updated\",\n  \"targetUrl\": \"https://\u003chostname\u003e/\u003cpath\u003e/api/webhooks\",\n  \"resource\": \"rooms\",\n  \"event\": \"updated\",\n  \"secret\": \"\u003cWEBEXTEAMS_WEBHOOK_SECRET environment variable\u003e\"\n}\n```\n\n``` json\n{\n  \"name\": \"publicspaces memberships:all\",\n  \"targetUrl\": \"https://\u003chostname\u003e/\u003cpath\u003e/api/webhooks\",\n  \"resource\": \"memberships\",\n  \"event\": \"all\",\n  \"secret\": \"\u003cWEBEXTEAMS_WEBHOOK_SECRET environment variable\u003e\"\n}\n```\n\nAlternatively, you could create a firehose webhook.\n\n``` json\n{\n  \"name\": \"publicspaces all:all\",\n  \"targetUrl\": \"https://\u003chostname\u003e/\u003cpath\u003e/api/webhooks\",\n  \"resource\": \"all\",\n  \"event\": \"all\",\n  \"secret\": \"\u003cWEBEXTEAMS_WEBHOOK_SECRET environment variable\u003e\"\n}\n```\n\nIt's probably easiest to use the Cisco Webex Teams developer [API docs](https://developer.webex.com/endpoint-webhooks-post.html).\n\nCisco Webex Teams Webhooks require https, so take a look at the Reverse Web Proxy section.\n\nReverse Web Proxy\n------------\n\nIt's expected that you'll front end this app with a reverse web proxy as the app doesn't natively support https. Cisco Webex Teams Webhooks require https, so that endpoint will have to have a proxy. While you could just put a proxy in front of the webhook endpoint, its recommend that all endpoints are served over https.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebex%2Feurl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebex%2Feurl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebex%2Feurl/lists"}