Skip to main content

Authorization

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

BigMailer

Prerequisites​

BigMailer authenticates API requests using an API key passed in the X-API-Key request header. Before creating a BigMailer credential in Nexla, you must generate an API key from the BigMailer console.

Required Account Role​

Only Account Administrators and Account Managers can access the API key management page. If you do not have one of these roles, contact your BigMailer account administrator to obtain a key on your behalf or to have your role updated.

Generate a BigMailer API Key​

  1. Sign in to your BigMailer account at https://app.bigmailer.io.

  2. Navigate to the API key management page by clicking your account avatar in the upper-right corner of the console and selecting Account Settings, then choosing the API tab. The page is also directly accessible at https://app.bigmailer.io/console/accounts/api.

  3. Click the Create Key button to open the new key dialog.

  4. Enter a descriptive name for the key in the Name field. Choose a name that identifies the application or integration that will use this key (for example, Nexla Integration). This helps with auditing and key rotation later.

  5. Click Create (or Save) to generate the key.

  6. Copy the generated API key and store it in a secure location.

    Important

    The full API key is shown only once at the time of creation. Copy it immediately and store it securely—you will not be able to view the full key again from the BigMailer console. If the key is lost, you will need to create a new one.

For additional details about API authentication and request format, refer to the official BigMailer documentation at https://docs.bigmailer.io/docs/getting-started-api.

Locate Brand IDs (Optional)​

Most BigMailer API endpoints operate within the context of a specific brand and require a brand ID as a path parameter. To find brand IDs in advance:

  1. In the BigMailer console, navigate to the Brands page from the left-hand menu.

  2. Click on a brand to open its detail page. The brand ID appears in the page URL (the path segment after /brands/) and on the brand settings page.

Brand IDs can also be retrieved programmatically through Nexla using the BigMailer List brands in your account source endpoint.

Create a BigMailer Credential​

  • To create a new BigMailer 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 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. Paste the BigMailer API key generated above into the API Key field. Nexla stores this value securely and sends it in the X-API-Key header on every request to the BigMailer API.

    Treat the API key like a password. Do not commit it to source control, share it in plain text, or paste it into shared documents. Rotate the key by creating a new one in the BigMailer console and updating the credential in Nexla if it may have been exposed.

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. Nexla will validate the key by issuing a test request to the BigMailer GET /v1/me endpoint.

  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.