What is the Climax integration?
The Climax integration connects your Climax carbon management account to KEY ESG and pulls your company’s carbon footprint data automatically each day. Once configured, Climax becomes your data entry method for carbon data, replacing manual input with a live, automatically refreshed feed.
The integration covers Scopes 1, 2, and 3 and maps Climax’s reporting categories to KEY ESG data points. All submissions are attributed to a “Climax Integration” user in your audit trail.
KEY ESG pulls data from Climax. Data is submitted at the organisation level and is applied to your main entity.
Before you begin
You will need:
The Climax integration enabled on your KEY ESG account. If you do not see Climax listed under Integrations > Others, contact your KEY ESG account manager.
A valid Climax API key with granular access granted to KEY ESG. Contact your Climax administrator if you do not have one.
The reporting year launched in KEY ESG. The integration cannot be enabled for a year until it has been launched.
The data entry method ‘use figure from Climax integration’ selected in your data collection area
Setting up the integration
Step 1: Enable the integration
Log into your KEY ESG account.
2. Navigate to Integrations > Others.
3. Click Configure next to the Climax integration.
4. The configuration page shows which years the integration is enabled for.
Step 2: Set Climax as your data collection method
In your carbon data collection settings, set the data entry method to Climax for Scopes 1, 2, and 3. This step is required, the Climax data format only maps correctly to KEY ESG data points when this method is selected.
Step 3: Opt in to all carbon data points
All 21 carbon data points must be opted in before the first sync can run. The system checks that each data point is assigned to your main entity before enabling the integration.
After the first sync completes, you can opt out of individual data points for which you have no data. Do not opt out before or during the initial sync, this will cause the integration to fail.
When opting out after syncing, opt out at the data-point (question-group) level, not at the entity level. Opting out only at the entity level while leaving the overall data-point opted in can cause sync failures on future runs.
Step 4: Enter your Climax API key
Enter the API key provided by your Climax administrator and save the configuration.
Step 5: Enable the integration for your reporting year(s)
On the Climax configuration page, enable the integration for each reporting year you want to sync.
2. The year must already be launched in KEY ESG for the option to appear.
3. Once enabled, the integration will run automatically the following morning at approximately 6:00 AM.
How the sync works
The sync runs once per day at approximately 6:00 AM. Each run replaces previously ingested Climax data with the latest values from the Climax API.
Data is submitted at the organisation level only. Climax does not provide a site or entity breakdown, so all submissions are applied to your main entity.
All submissions are attributed to a “Climax Integration” user, making it easy to identify Climax-sourced data in your audit history.
KEY ESG syncs daily, but Climax controls when its own data is updated.
Troubleshooting
The integration cannot be enabled for a year
The most common causes are:
The reporting year has not been launched in KEY ESG. Navigate to your data collection settings, launch the year, then return to the integration configuration.
One or more of the 21 carbon data points are opted out. Opt all data points back in, confirm the main entity is opted in at the org level, then try enabling again.
The sync is failing after I opted out of some data points
This usually means data points were opted out at the entity level only, while the question-group remains opted in. The integration validates opt-in status against the main entity.
To fix this: opt your entities back in, then opt out at the question-group (data-point) level instead. This is the correct method for removing data points you do not need.
Note: If you have opted out of Scope 3 sub-categories and Climax contains data for those categories, the sync will be blocked. The platform cannot write incoming data to an opted-out field. Keep all Scope 3 data points opted in until you are confident that Climax holds no data for them.
No data is appearing after the sync
Confirm that granular access has been granted to KEY ESG within your Climax account settings.
Check that your API key is correct and has not expired.
The integration is not visible in my settings
The Climax integration must be enabled on your account by KEY ESG before it appears. Contact your KEY ESG account manager to confirm it is active for your company.
FAQs
Can the integration be set up for prior years?
Yes. The integration can be configured for historical years provided the year has been launched in KEY ESG and any existing direct-entry submissions for those data points have been removed. Contact KEY ESG support to discuss setting this up.
Does the integration support entity- or site-level data?
No. Climax provides organisation-level data only. All submissions are applied to your organisation’s main entity. If your reporting structure requires entity-level carbon data, this will need to be entered separately via direct entry.
What happens to my existing data when I enable the integration?
Switching to the Climax data entry method removes existing direct-entry submissions for the relevant carbon data points. Export your data from KEY ESG before enabling the integration if you want to keep a copy.
How often does my data update?
KEY ESG syncs with Climax once per day at approximately 6:00 AM. Each sync overwrites the previous Climax data. The frequency at which Climax publishes new data is controlled by Climax.
Who do I contact if something is not working?
Contact us at support@keyesg.com. Include the name of the affected reporting year and a description of the issue.