Settings¶

class heroku_connect.conf.HerokuConnectAppConf(**kwargs)[source]¶

HEROKU_AUTH_TOKEN = ''[source]¶

Heroku Platform API’s Direct Authorization token.

This setting is OPTIONAL. It is required only if you are using the health-check application.

To obtain this token, first we need to have a Heroku API token.

API token can be fetched using command heroku auth:token. More about Heroku API tokens here - https://devcenter.heroku.com/articles/authentication#retrieving-the-api-token.

After we have our API token, we can fetch the Direct Authentication token by using a process called Token Exchange.

Complete details about this process are provided in this link - https://devcenter.heroku.com/articles/oauth#direct-authorization-token-exchange.

HEROKU_CONNECT_API_ENDPOINT = 'https://connect-eu.heroku.com/api/v3'[source]¶

Heroku Connect API Endpoint.

This setting is OPTIONAL. It is required only if you are using the health-check application. Default is https://connect-eu.heroku.com/api/v3.

Check your endpoints at this link - https://devcenter.heroku.com/articles/heroku-connect-api#endpoints.

HEROKU_CONNECT_APP_NAME = 'ninja'[source]¶

Heroku application name.

This setting will have default based on your environment should you have Dyno Metadata enabled.

HEROKU_CONNECT_ORGANIZATION_ID = '1234567890'[source]¶

Salesforce Organization ID.

This setting will have default based on the environment variable HEROKU_CONNECT_ORGANIZATION_ID.

Note

This is not preset on your Heroku application. You will need to either add a setting or set the environment variable manually.

HEROKU_CONNECT_SCHEMA = 'salesforce'[source]¶

Database schema used by the Heroku Connect add-on.

This setting is OPTIONAL and based on the environment variable HEROKU_CONNECT_SCHEMA. It is required only if you chose a different schema for Heroku Connect tables. Default is salesforce.