Overview
If you're connecting CX Platform to another system such as your CRM, a billing engine, a customer portal — those systems will submit documents to your Application via the API. The Integration settings are where you control how that connection works and which submission mode they use.
You'll find these settings inside the Application's Details page, in a card called Integration Settings. They're per-Application, so each Application can have its own credentials and submission rules — handy when different systems are sending different types of communications.
You don't need to touch these settings for manual sends or scheduled jobs. They only come into play when something is submitting documents to CX Platform via the API, from an external system or connection to a digital form action in the Receive module.
Find the Integration settings
- In the secondary navigation menu, click Applications to view a list of all available Applications.
- Double click the Application you want to configure, or click the Settings icon on the right hand of the list view.
- Open the Details tab and scroll down to the Integration Settings card.
- Configure your required settings
- Scroll to the bottom of the Details page and click Save.
API Key
The API Key is a unique identifier generated automatically when the Application is created. Think of it as your Application's calling card — when an external system submits a document, this is the value it uses to tell CX Platform which Application the request is for.
You can't edit the key, but you can copy it using the copy icon next to the value. You'll typically paste this into the integration settings of whichever system is submitting documents (your CRM, middleware, or wherever the request originates).
Treat your API Key like a password
Anyone with this key can submit data payloads (and authentication credentials) to your Application, so share it carefully and only with the systems and people that need it.
API code
The API code is an optional alternative to the API Key. You can set your own value here and use it in place of the API Key when submitting data payloads— useful if you'd rather use a friendlier or more memorable identifier than a long UUID.
That said, the API Key is the preferred option. It's automatically unique and harder to guess, which makes it the safer choice for production integrations. Only set an API code if you've got a specific reason to use one.
Handy for connecting Receive to Send
The API code comes into its own when you're setting up an automated notification action on a digital form in the Receive module. Because you can set it to something meaningful — like welcome-email or policy-confirmation — it's much easier to pick out the right Send Application from a list than scanning through UUIDs. If your Application is going to be triggered from a digital form, setting an API code here will save you (and anyone else configuring forms) a lot of squinting later.
Allow API submission
This setting controls whether external systems are allowed to submit documents to this Application at all, and if they are, which submission mode they'll use. Choose from three options in the dropdown:
- Disabled — no API submissions are accepted. This is the default, and the right choice if the Application isn't connected to any external system.
- Normal (Recommended) — near instant submission with access to the full set of advanced features. This is the option to pick for most live integrations.
- One time pin — instant submission with a more limited feature set. Useful for lightweight or single-use scenarios where you don't need the full feature set.
Not sure which to pick?
Stick with Normal (Recommended) unless you've got a specific reason to use One time pin. It covers the broadest range of use cases and gives you access to everything the API offers.
Save your changes
Once you've set your Api code (if you're using one) and chosen your Allow API submission mode, scroll to the bottom of the Details page and click Save.
That's it — your Application is now ready to receive submissions from your connected system. Hand the Api Key (or Api code) to whoever's setting up the integration on the other end, and they'll have everything they need to start sending documents through.
You'll also need to have a system API key configured with IPs whitelisted before you can actually start sending - refer to our API docs or contact us for support.