Where can I find the Conversions API key, and how is it used?
The Conversions API key is a secret key that authorizes conversion events to be sent from your shop’s server to OpenAI. It is required when you enable the Conversions API in the ChatGPT Ads module.
It must not be confused with the Pixel ID: the Pixel ID identifies your Web data source, whereas the Conversions API key authenticates server-side deliveries associated with that source.
Create and retrieve the key in OpenAI Ads Manager
Sign in to OpenAI Ads Manager, then open the “Conversions” section. Select the Web data source associated with your shop and create a Conversions API key for that source.
Copy the key when it is displayed and store it securely. It allows the module to send events on behalf of your data source.
Enter the key in the module
In the ChatGPT Ads module configuration, enter the Conversions API key in the relevant field. Also check that the Pixel ID configured in the module matches the same Web data source in OpenAI Ads Manager.
After saving the configuration, the module can use this key to send server-side events, for example when an order is validated, depending on the options enabled in your configuration.
What is the key used for?
The key allows OpenAI to verify that the events sent by the module are authorized for the relevant data source. It is used for Conversions API server-side requests, not to display the Pixel in the visitor’s browser.
Events sent with this key may contain the information required to measure a conversion, such as the event type, date, identifier, amount, and currency when those data apply.
When the same conversion is sent through both the Pixel and the Conversions API, both deliveries must use the same Pixel ID and event ID. OpenAI can then deduplicate the action and avoid counting it twice.
Protect the Conversions API key
Treat this key as confidential information. Do not add it to your theme code, a public page, a script running in the browser, or a shared screenshot.
If you believe that the key has been exposed, create a new key in OpenAI Ads Manager, replace the previous key in the module configuration, and disable or revoke the compromised key according to the options available in your account.
Check event delivery
After configuring the key, use Validation only mode to check that new events are accepted without recording them as actual conversions. Disable this mode after checking your configuration.
See our FAQ What is Validation mode used for, and when should I disable it?. To understand the role of the Conversions API, also see our FAQ What is the Conversions API used for, and how does it work?.
You can find further information in the official OpenAI Ads Conversions API documentation and the Conversion Setup documentation.
Other FAQs in this category
- How do feed generation reports work, and how should you interpret warnings and errors?
- How does customer matching work, and what data is used?
- What is Validation mode used for, and when should I disable it?
- What is the Conversions API used for, and how does it work?
- How does user consent affect event tracking?
- Where can I find my Pixel ID, and what is it used for?
- What is the Pixel used for, and why should I enable it?