https://github.com/stormpath/stormpath-intercom
Stormpath + Intercom sync
https://github.com/stormpath/stormpath-intercom
Last synced: 5 months ago
JSON representation
Stormpath + Intercom sync
- Host: GitHub
- URL: https://github.com/stormpath/stormpath-intercom
- Owner: stormpath
- Created: 2015-01-28T21:34:44.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-03-06T16:14:55.000Z (over 8 years ago)
- Last Synced: 2025-01-28T04:28:35.472Z (9 months ago)
- Language: JavaScript
- Size: 94.7 KB
- Stars: 3
- Watchers: 24
- Forks: 1
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#Stormpath is Joining Okta
We are incredibly excited to announce that [Stormpath is joining forces with Okta](https://stormpath.com/blog/stormpaths-new-path?utm_source=github&utm_medium=readme&utm-campaign=okta-announcement). Please visit [the Migration FAQs](https://stormpath.com/oktaplusstormpath?utm_source=github&utm_medium=readme&utm-campaign=okta-announcement) for a detailed look at what this means for Stormpath users.
We're available to answer all questions at [support@stormpath.com](mailto:support@stormpath.com).
# stormpath-intercom
*Sync your Stormpath accounts with Intercom!*
[](https://npmjs.org/package/stormpath-intercom)
[](https://npmjs.org/package/stormpath-intercom)
![Stick Figure Sketch][]
## Purpose
If you use [Stormpath][] to store and manage your user accounts,
`stormpath-intercom` can be used to easily sync your user data to [Intercom][]'s
amazingly awesome CRM system.
This is useful, because this simple CLI tool allows you to easily keep your
Intercom CRM completely up-to-date with all your user information.
# Install
You can install `stormpath-intercom` through [npm][] by
running:
```console
$ npm install -g stormpath-intercom
```
**NOTE**: If you aren't using an environment manager like `nvm`, you may need to
run the above command with `sudo`.
## Usage
Using `stormpath-intercom` is easy! You can sync your user data by running the
following CLI command:
```console
$ stormpath-intercom \
--stormpath-api-key-id=xxx \
--stormpath-api-key-secret=xxx \
--stormpath-app-name=myapp \
--intercom-app-id=xxx \
--intercom-api-key=xxx
```
I know it's a bit long, but to make things work you need to specify 5 separate
CLI arguments:
- `--stormpath-api-key-id`: Your Stormpath API key ID.
- `--stormpath-api-key-secret`: Your Stormpath API key secret.
- `--stormpath-app-name`: Your Stormpath application name to sync.
- `--intercom-app-id`: Your Intercom app ID (*this can be found in your settings
under API keys*).
- `--intercom-api-key`: Your Intercom API key (*this can be found in your
settings under API keys*).
This might take a while, depending on how many user accounts you have.
**NOTE**: For best results, consider running `stormpath-intercom` on a cron
job -- this way, any user accounts you have will be automatically synced with
Intercom, and you'll continuously have an up-to-date directory of users!
[Stick Figure Sketch]: https://github.com/stormpath/stormpath-intercom/raw/master/assets/stick-figure-sketch.png "Stick Figure Sketch"
[Stormpath]: https://stormpath.com/ "Stormpath"
[Intercom]: https://www.intercom.io/ "Intercom"
[npm]: https://www.npmjs.org/ "npm"