v8 (v7 Rails v1 Django)
Getting Started
Reference Guide
Integrations
Integrations
Forest is able to leverage data from third party services by reconciliating it with your application’s data, providing it directly to your admin. All your admin actions can be performed at the same place, bringing additional intelligence to your admin and ensuring consistency.
Stripe
Configuring the Stripe integration for Forest allows you to have your customer’s payments, invoices, cards and subscriptions (1) alongside the corresponding customer from your application. A
Refund Smart Action (2,3) is also implemented out-of-the-box.
SQL
Mongodb
Rails
On our Live Demo, we’ve configured the Stripe integration on the
customers collection. The Stripe Customer ID is already stored on the database under the field stripe_id.middlewares/forestadmin.js
1
...
2
const { objectMapping, connections } = require('../models');
3
4
module.exports = function (app) {
5
app.use(Liana.init({
6
configDir: path.join(__dirname, '../forest'),
7
envSecret: process.env.FOREST_ENV_SECRET,
8
authSecret: process.env.FOREST_AUTH_SECRET,
9
objectMapping,
10
connections,
11
integrations: {
12
stripe: {
13
apiKey: process.env.STRIPE_SECRET_KEY,
14
mapping: 'customers.stripe_id',
15
stripe: require('stripe')
16
}
17
}
18
}));
19
20
console.log(chalk.cyan('Your admin panel is available here: https://app.forestadmin.com/projects'));
21
};
Copied!
On our Live Demo, we’ve configured the Stripe integration on the
customers collection. The Stripe Customer ID is already stored on the database under the field stripe_id.middlewares/forestadmin.js
1
...
2
const { objectMapping, connections } = require('../models');
3
4
module.exports = function (app) {
5
app.use(Liana.init({
6
configDir: path.join(__dirname, '../forest'),
7
envSecret: process.env.FOREST_ENV_SECRET,
8
authSecret: process.env.FOREST_AUTH_SECRET,
9
objectMapping,
10
connections,
11
integrations: {
12
stripe: {
13
apiKey: process.env.STRIPE_SECRET_KEY,
14
mapping: 'customers.stripe_id',
15
stripe: require('stripe')
16
}
17
}
18
}));
19
20
console.log(chalk.cyan('Your admin panel is available here: https://app.forestadmin.com/projects'));
21
};
Copied!
On our Live Demo, we’ve configured the Stripe integration on the
Customer collection. The Stripe Customer ID is already stored on the database under the field stripe_id./config/initializers/forest_liana.rb
1
ForestLiana.env_secret = Rails.application.secrets.forest_env_secret
2
ForestLiana.auth_secret = Rails.application.secrets.forest_auth_secret
3
4
ForestLiana.integrations = {
5
stripe: {
6
api_key: ENV['STRIPE_SECRET_KEY'],
7
mapping: 'Customer.stripe_id'
8
}
9
}
Copied!
Available options
Here are the complete list of available options to customize your Stripe integration.
Name
Type
Description
api_key
string
The API Secret key of your Stripe account. Should normally starts with
sk_.mapping
string
Indicates how to reconcile your Customer data from your Stripe account and your collection/field from your database. Format must be
model_name.stripe_customer_id_fieldMixpanel
The Mixpanel integration allows you to fetch Mixpanel’s events and display them at a record level into Forest.
SQL
Mongodb
Rails
To benefit from Mixpanel integration, you need to add the package
mixpanel-data-export before going further.Then, add the following code to your
app.js file. In our example we will map the customers.email with the data coming from Mixpanel. You may replace by your own relevant collection(s).By default, Mixpanel is sending the following fields: id, event, date, city, region, country, timezone, os, osVersion, browser, browserVersion. If you want to add other fields from Mixpanel, you have to add them in
customProperties:middlewares/forestadmin.js
1
...
2
const { objectMapping, connections } = require('../models');
3
4
module.exports = function (app) {
5
app.use(Liana.init({
6
configDir: path.join(__dirname, '../forest'),
7
envSecret: process.env.FOREST_ENV_SECRET,
8
authSecret: process.env.FOREST_AUTH_SECRET,
9
objectMapping,
10
connections,
11
integrations: {
12
mixpanel: {
13
apiKey: process.env.MIXPANEL_API_KEY,
14
apiSecret: process.env.MIXPANEL_SECRET_KEY,
15
mapping: ['customers.email'],
16
customProperties: ['Campaign Source', 'plan', 'tutorial complete'],
17
mixpanel: require('mixpanel-data-export')
18
},
19
},
20
}));
21
22
console.log(chalk.cyan('Your admin panel is available here: https://app.forestadmin.com/projects'));
23
};
Copied!
To benefit from Mixpanel integration, you need to add the package
mixpanel-data-export before going further.Then, add the following code to your
app.js file. In our example we will map the customers.email with the data coming from Mixpanel. You may replace by your own relevant collection(s).By default, Mixpanel is sending the following fields: id, event, date, city, region, country, timezone, os, osVersion, browser, browserVersion. If you want to add other fields from Mixpanel, you have to add them in
customProperties:middlewares/forestadmin.js
1
...
2
const { objectMapping, connections } = require('../models');
3
4
module.exports = function (app) {
5
app.use(Liana.init({
6
configDir: path.join(__dirname, '../forest'),
7
envSecret: process.env.FOREST_ENV_SECRET,
8
authSecret: process.env.FOREST_AUTH_SECRET,
9
objectMapping,
10
connections,
11
integrations: {
12
mixpanel: {
13
apiKey: process.env.MIXPANEL_API_KEY,
14
apiSecret: process.env.MIXPANEL_SECRET_KEY,
15
mapping: ['customers.email'],
16
customProperties: ['Campaign Source', 'plan', 'tutorial complete'],
17
mixpanel: require('mixpanel-data-export')
18
},
19
},
20
}));
21
22
console.log(chalk.cyan('Your admin panel is available here: https://app.forestadmin.com/projects'));
23
};
Copied!
To benefit from Mixpanel integration, you need to add the
gem 'mixpanel_client' to your Gemfile.Then, add the following code to your initializer. In our example we will map the
Customer.email with the data coming from Mixpanel. You may replace by your own relevant collection(s).By default, Mixpanel is sending the following fields: id, event, date, city, region, country, timezone, os, osVersion, browser, browserVersion. If you want to add other fields from Mixpanel, you have to add them in
customProperties:/config/initializers/forest_liana.rb
1
ForestLiana.env_secret = Rails.application.secrets.forest_env_secret
2
ForestLiana.auth_secret = Rails.application.secrets.forest_auth_secret
3
4
ForestLiana.integrations = {
5
mixpanel: {
6
api_key: 'YOUR MIXPANEL API KEY',
7
api_secret: 'YOUR MIXPANEL SECRET KEY',
8
mapping: ['Customer.email'],
9
custom_properties: ['Campaign Source', 'plan', 'tutorial complete'],
10
}
11
}
Copied!
You will then be able to see the Mixpanel events on a record, a
Customer in our example.
Intercom
Configuring the Intercom integration allows you to display your user’s session data (location, browser type, …) and conversations.
In order for your intercom integration to work properly, you will have to use the version 2 of intercom API. To do so, you'll need go to the intercom developer hub and ensure that the app registered to retrieve your API key uses the intercom API version 2.0.
First, add the intercom client as a dependency to your project:
SQL
Mongodb
Rails
1
npm install [email protected]
Copied!
1
npm install [email protected]
Copied!
Gemfile
1
gem 'intercom'
Copied!
Then, you need to add the intercom integration:
SQL
Mongodb
Untitled
middlewares/forestadmin.js
1
...
2
const intercomClient = require('intercom-client');
3
const { objectMapping, connections } = require('../models');
4
5
module.exports = async function (app) {
6
app.use(await Liana.init({
7
configDir: path.join(__dirname, '../forest'),
8
envSecret: process.env.FOREST_ENV_SECRET,
9
authSecret: process.env.FOREST_AUTH_SECRET,
10
objectMapping,
11
connections,
12
integrations: {
13
intercom: {
14
accessToken: process.env.INTERCOM_ACCESS_TOKEN,
15
intercom: intercomClient,
16
mapping: ['users.email'],
17
},
18
},
19
}));
20
21
console.log(chalk.cyan('Your admin panel is available here: https://app.forestadmin.com/projects'));
22
};
Copied!
middlewares/forestadmin.js
1
...
2
const intercomClient = require('intercom-client');
3
const { objectMapping, connections } = require('../models');
4
5
module.exports = async function (app) {
6
app.use(await Liana.init({
7
configDir: path.join(__dirname, '../forest'),
8
envSecret: process.env.FOREST_ENV_SECRET,
9
authSecret: process.env.FOREST_AUTH_SECRET,
10
objectMapping,
11
connections,
12
integrations: {
13
intercom: {
14
accessToken: process.env.INTERCOM_ACCESS_TOKEN,
15
intercom: intercomClient,
16
mapping: ['users.email'],
17
},
18
},
19
}));
20
21
console.log(chalk.cyan('Your admin panel is available here: https://app.forestadmin.com/projects'));
22
};
Copied!
/config/initializers/forest_liana.rb
1
ForestLiana.integrations = {
2
# ...
3
intercom: {
4
access_token: ENV['INTERCOM_ACCESS_TOKEN'],
5
mapping: ['Customer']
6
}
7
}
Copied!
intercomis used to pass the intercom client version. To do so, you have to require the previously installed client, as in the example.accessTokenshould be defined in your environment variable and is provided by intercom.mappingrefers to the collection and field name you want to map to intercom data. It can either be a field that contain emails that refer to intercom users or a field that contain ids mapping theexternal_idin Intercom API.
You will have to restart your server to see Intercom plugged to your project.
Others
As mentioned above, we natively support 3 integrations:
- Intercom
- Mixpanel
- Stripe
However, basically any integration can be built using our smart features: Smart Actions, Smart Collections, Smart Relationships and Smart Charts.
Last modified 2mo ago
Copy link