Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API updates to reflect Webex Teams rebrand #1349

Merged
merged 3 commits into from
Oct 19, 2018

Conversation

ObjectIsAdvantag
Copy link
Contributor

See #1346 for context.

The proposed changes here also introduce backward compatibility as described in the Webex rebrand documentation section:

Back in April 2018, Cisco announced a rebrand from Cisco Spark to Webex. In May 2018, starting with version TODO, Botkit reflected this rebrand by updated 'Spark' mentions from the framework API.

For backward compatibility purposes, several references are now marked as deprecated, but still supported (except for Typescript code). Please migrate your code if your find references to:

  • Botkit.sparkbot() => Botkit.webexbot()
  • controller.config.ciscospark_access_token => controller.config.access_token: a warning shows up in the console if your code is still using this option.

Breaking changes

  • bot.type now equals 'webex' instead of 'ciscospark': there should not be any impact in your code.
  • the webhook HTTP endpoint automatically created and exposed by Botkit has been changed from '/ciscospark/receive' to '/webex/receive'. Note that this change can have an impact for the Webex Cloud platform to reach your bot if the traffic to your bot is routed by a reverse proxy. To avoid any bot to break, the Botkit Webex connector will expose an HTTP endpoint with the deprecated '/ciscospark/receive' path if the 'ciscospark_access_token' configuration property is detected.

These modifications have been tested against the convos@sparkbot.io which implements various examples with the Botkit conversation object. The proposed implementation has let me take an incremental changes with no breaking changes, as detailled in the releases of the convos bot project

@jfield44
Copy link

@benbrown any objections to this one?

@benbrown
Copy link
Contributor

@jfield44 No! Let me run it through the paces one more time and we can include it in the next release.

Copy link
Contributor

@benbrown benbrown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for all the work, @ObjectIsAdvantag! One small note - we'll have to make these docs changes again in the botkit-docs repo once this goes live.

@benbrown benbrown merged commit 4a12bf4 into howdyai:master Oct 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants