intercom-archive / intercom-ruby-app Goto Github PK

Goal

As a developer, I want to build JavaScript apps using Intercom data. A local proxy would allow me to do so, so that calling http://localhost:3000/api/what/ever?foo=bar will have the same effect as calling http://api.intercom.io/what/ever?foo=bar

A/C

• The proxy must translate any URL to the Intercom API, so that it doesn't require any change when we update the API.
• Also, it must use the oAuth credentials stored in session data, so that critical user information will never be exposed to users / front-end apps.

Use-case scenario:

• A user logs-in to a intercom-ruby-app instance
• They can visit /api/users which will translate to https://api.intercom.io/users and list all users (same response data)
• All those /api URLs can subsequently be used in Javascript, w/o cross-domain or authentication issues
• When the user logs-out from the app, /api queries will be denied

Calling

p app_session

returns

{}

from HomeController::index after you authenticated with Intercom

• Add support for webhooks registration
• Add a webhook controller generator with security checks
• Integrate static assets

Some integrations require a different identifier than the app_id.
For example an intercom-github integration to post issues from intercom would require every admin who want to use the integration to authenticate.
For an integration with a CMS (like in the open source intercom-wix integration) several website could use the same app_id.

Use Intercom PAT to :

• create/update users on oauth callback
• tag users as "Integrated with [APP NAME]
• Add event to users timeline
• Create companies ? Based on Intercom's app name and id_code ?