Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/n0nag0n/flee-intercom

For those of you who like to keep your money after Intercom jacks up the prices year after year, but want to keep an export of your data.
https://github.com/n0nag0n/flee-intercom

again-and-again api data database export exporter flee high-prices intercom mysql php price run save saver year-over-year

Last synced: about 2 months ago
JSON representation

For those of you who like to keep your money after Intercom jacks up the prices year after year, but want to keep an export of your data.

Awesome Lists containing this project

README 

        
Flee Intercom!

====



Tired of Intercom jacking up the price on you and want to go somewhere else, but need to drag your sorry data with you? Look no further, I'm here to help. This will help you export your data from Intercom so you can use it in your own personal database, or import it to another chat tool of your choice.



What's this for....exactly?

----

This will pull back all users, and all conversations attached to those users and stick it in a MySQL database for you to use later when you need to take it and put it somewhere else. This is just boilerplate code you for. You'll need to change what fields you want to save in the code after you clone/fork/copy this repo.



Requirements

----

- MySQL 5.6.1+

  - **Make sure to set your max_allowed_packet higher than the default of 16MB or your import mail fail. Go for 100MB for kicks.**

- PHP 7+ with cURL and JSON extensions loaded (maybe some others)

- Half a brain



Installation

----

- Get your database up and running. 

  - The schema is located in `initial_db_schema.sql`. You can simply run `mysql < initial_db_schema.sql` to get your database setup. 

  - You'll then need to setup db permissions for your MySQL user. 

- Take the `config.sample.php` file and rename it to `config.php` with your appropriate values.

- Run `composer install` to get the right packages to make this kitty purr.



Usage

----

Assuming you've set up your database permissions correctly, you can then run: 



```bash

php rip_that_data_back_from_them.php

``` 



and off it will go :)



There is another script called `unsnooze_and_snooze.php` that will go through all the conversations you've pulled back and unsnooze them and then snooze them. This is used in some cases with integrations you may have with Intercom where you need conversations to unsnooze and snooze in order for a integration to trigger.



API

----

Simple test usage is done by running `php -S localhost:8000 -t public/`. There are 4 routes defined in the `public/index.php` file.



`GET|POST /api/getConversationHistoryByEmailAddress`



You need to define the `email` param and it will return a JSON response of all your data.



`GET|POST /getConversationHistoryByEmailAddress`



You need to define the `email` param and it will return a HTML response of all your data with some minimal markup.



`GET|POST /downloadFile`



You need to define the `id` and `unique_filename_hash` param and it will download the file. If you add `&image=true` to the request, the url will be able to be used in a `` tag.



`GET|POST /checkEmail`



Has a simple form for you to check the data.



There is a simple api that can be used. Just define an api_token in the `config.php` file. Then on any request, you can have a GET or POST param of `api_token` to authenticate with the api endpoints. You can also specify `Authorization: Bearer [api_token]` as a header.



This is just to cover the bare minimum of security. There are much more hardened practices that could be used with this.



Other Notes

----

This is currently based on Intercom v1.4 API