Skip to content
Contlo by QuestionPro
Browse documentation

API keys, webhooks and callback URLs

API keys let your website, app and backend talk to Contlo: to track what shoppers do, keep contacts up to date and trigger messages at the right moment. Contlo has two kinds of key, one that is safe to expose and one that must stay secret. This article shows where to find them, how to manage them, and where to set up webhooks and callback URLs.

Settings → Marketing Settings → API KeysOne public keyAny number of named private keysRevoke at any time

Public and private keys

Public API KeyPrivate API Keys
How manyOne per accountAs many as you need, each with its own name
Shown on screenIn fullMasked. Use the copy button to get the value
Can you create or delete itNoYes
Where it belongsWebsite and app codeServer-side code and secure integrations only

Open API Keys

  1. Open the account menu in the top bar and choose Settings.
  2. Choose Marketing Settings in the left menu.
  3. Open the API Keys tab.

If you see "Settings are managed by the account owner", your role doesn't include these settings. Ask the account owner for the key you need, or see Team and roles.

Copy your public key

The Public API Key card at the top of the tab shows your key. Click Copy to put it on your clipboard. You see "API Key Successfully Copied!".

You need this key when you add Contlo tracking to your website. See Install web tracking and Track events and identify. For apps, see Mobile SDKs.

Create a private key

The Private API Keys table lists every private key with its Name, masked API Key, Created At date and actions. Your account starts with one private key already in the list.

  1. Click Create API Key.
  2. In Key name, give the key a name that says what it is for, for example Order sync or Data warehouse.
  3. Click Create. The new key appears in the table.
  4. Click the copy button beside the masked key and paste it into the tool or code that needs it.

Use a different name for each key. If you create a key with a name that is already in the list, no new key is added.

Rename or revoke a private key

Rename

Click the key's name or Edit, change the name in Edit API Key Name and click Update. Only the name changes. The key value stays the same, so nothing that uses it needs updating.

Revoke

  1. Open More actions on the key's row and choose Delete.
  2. Check the name in the Delete API Key confirmation.
  3. Click Yes, Delete.

Keep private keys secret

  • Never put a private key in website code, a mobile app, or anything else a visitor can download. Use the public key there.
  • Don't paste private keys into email, chat or support tickets. Contlo will not ask you for one.
  • Store keys in your server's secret storage or environment settings, not in source code.
  • If a key may have been exposed, create a new one, update your integration, then delete the exposed key.
  • Delete keys that are no longer used.

For what you can do with a private key, including authentication and the available endpoints, see the REST API article.

Webhooks and callback URLs

There is no separate webhook page in Settings. Contlo sends and receives data through URLs in three places, depending on what you want to do.

What you wantWhere to set it upHow it works
Send data from Contlo to your own system when something happensThe Webhook action in an automationContlo sends customized data to an external URL with a POST request. You set the Destination URL, any Request Headers and the Request Body on the action. See Automation triggers and actions.
Let another app send data into ContloThe app's page in the App MarketSome integrations show a Webhook URL to copy and paste into the other app's dashboard. See Integrations catalog.
Get SMS delivery and click data back from your SMS vendorCallback URL in SMS settingsFor TrustSignal accounts, you copy the Callback URL from Contlo and paste it in your vendor dashboard. Open it again from the account's menu under Connected accounts. See SMS setup and settings.

Common questions

QuestionAnswer
Can I see a private key in full on screen?No. Private keys are always masked in the table. The copy button copies the full value.
"Please enter a key name"The name is required when you create or rename a key.
Can I change my public key?Not from Settings. If you believe you need a new one, write to hello@contlo.com.
My integration stopped working after I cleaned up keysThe key it used was probably deleted. Create a new private key and update the integration with it.

Related guides

Can't find something? Email us