Skip to main content

Authorization

Follow this guide to create a new Elastic Email credential that will allow Nexla to authenticate to and exchange data with your Elastic Email account.
elasticemail_api_auth.png

Elastic Email

Prerequisites​

To connect Nexla to Elastic Email, you will need an active Elastic Email account and an API key generated from that account. Elastic Email authenticates all API v4 requests using an API key passed in the X-ElasticEmail-ApiKey request header—no OAuth flow or username/password combination is required.

Generate an Elastic Email API Key​

Elastic Email API keys are 96-character tokens that grant programmatic access to your account. Each account can hold up to 15 API keys, and each key can be scoped with specific permissions and optional IP address restrictions to reduce exposure if a key is ever compromised.

  1. Log in to your Elastic Email account.

  2. Click your profile avatar in the top-right corner of the dashboard, then select Settings from the dropdown menu.

  3. In the left-hand Settings navigation, select API.

  4. Click the Create API Key button.

  5. Enter a descriptive name for the key in the Name field. A name such as Nexla Integration makes it easy to identify the key's purpose later.

  6. Configure the permissions for the key. Elastic Email allows each API key to be scoped to only the access it requires. Select the permissions appropriate for how Nexla will use this credential:

    • View account information — required for basic connectivity verification during credential testing.

    • Manage contacts — required to read contact records or write new contacts to your account.

    • Manage campaigns — required to read campaign data or create and update campaigns via a destination flow.

    • Send emails — required to send transactional or bulk emails as a Nexla destination.

    • Manage templates — required to read or write email templates.

    • Manage lists — required to read contact lists or create and update lists.

    For full Nexla source and destination functionality across all available endpoints, enabling all of the permissions listed above is recommended. You can create additional API keys with narrower scopes for more restricted use cases.

  7. Optionally, enter an IP address or CIDR range in the Restrict to IP field to limit the key to requests from specific IP addresses. This provides an additional layer of security for production integrations.

  8. Click the Create button. A dialog will appear displaying the complete API key value.

warning

Copy and store the API key in a secure location immediately after creation. Elastic Email displays the full key value only once. After you close the dialog, only the last five characters of the key will be visible. If the key is lost, you will need to delete it and generate a new one.

For additional details on managing API keys, see the Elastic Email API Settings help article.

Create an Elastic Email Credential​

  • To create a new Elastic Email credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key​

  1. Enter your Elastic Email API key in the API Key Value field. This is the 96-character token generated in your Elastic Email account under Settings > API. Nexla passes this key with every request in the X-ElasticEmail-ApiKey HTTP header to authenticate with the Elastic Email REST API.

    Keep your API key confidential. Do not share it in source code repositories, log files, or other unsecured locations. If a key is compromised, delete it from your Elastic Email account immediately under Settings > API and generate a new one.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.