Skip to main content

Authorization

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

EmailOctopus

Prerequisites​

To connect Nexla to EmailOctopus, you will need an active EmailOctopus account and an API key. The EmailOctopus API uses Bearer token authentication, passing your API key in the Authorization request header for every API call. API keys are scoped to your account and grant access to all resources accessible within that account.

Obtain an EmailOctopus API Key​

EmailOctopus allows you to create and manage multiple named API keys from the Integrations & API section of your account dashboard.

  1. Log in to your EmailOctopus account at emailoctopus.com.

  2. Click your account name or profile icon in the top-right corner of the dashboard to open the account dropdown menu.

  3. Select Integrations & API from the dropdown menu.

  4. On the Integrations & API page, scroll to the Developer tools section and locate the API sub-section. Click the Manage button to open the API key management page.

  5. On the API keys page, click the Add key button at the bottom of the list.

  6. Enter a descriptive name for your new API key — for example, Nexla Integration — to help you identify it later. Click the Create button to generate the key.

  7. Your new API key will be displayed on the confirmation screen. Copy it immediately and store it in a secure location such as a password manager or secrets vault.

Important

The full API key value is displayed only once, at the moment of creation. After you navigate away from the confirmation page, EmailOctopus will not show the key again. If the key is lost, you must delete it and generate a new one.

EmailOctopus supports multiple API keys per account, making it straightforward to use separate keys for different integrations or environments. For complete information about creating and deleting API keys, see the EmailOctopus API key documentation.

Create an EmailOctopus Credential​

  • To create a new EmailOctopus 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 the EmailOctopus API key you generated in the API Key Value field. Nexla will transmit this key as a Bearer token in the Authorization header for all requests made to the EmailOctopus API on your behalf.

    Keep your API key confidential. Avoid storing it in source code repositories, log files, or other locations where it may be exposed. If you believe a key has been compromised, navigate to the EmailOctopus API key management page, delete the affected key, and create a replacement.

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.