Skip to main content

Authorization

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

SendGrid

Prerequisites​

Before creating a SendGrid credential, you need to obtain your API key from your SendGrid account. SendGrid uses API key authentication for all API requests, with the API key sent in the Authorization header with the Bearer prefix.

To obtain your SendGrid API key, follow these steps:

  1. Sign in to your SendGrid account using your administrator credentials.

  2. Navigate to your account settings or API management section in the SendGrid interface.

  3. Look for the API Keys or API section in your account settings, or navigate to Settings > API Keys or Account > API Keys.

  4. If you don't have an API key yet, look for the option to generate or create your API key.

  5. Click Create API Key or Generate API Key to create a new API key.

  6. Configure your API key settings:

    • Enter a name for the API key (e.g., "Nexla Integration")
    • Select the API key permissions (Full Access, Restricted Access, or Billing Access)
    • Review and select the specific permissions or scopes for the key (if using Restricted Access)

  7. Click Create & View or Create to create the API key.

  8. Copy the API key immediately after it's generated, as it may not be accessible again after you navigate away from the page.

  9. Store the API key securely, as you will need it to configure your Nexla credential. The API key is sensitive information and should be kept confidential.

The API key is sent in the Authorization: Bearer {key} header for all API requests to the SendGrid API. The API key authenticates your requests and grants access to SendGrid resources based on your account permissions. If your API key is compromised, you should immediately revoke it in your SendGrid account settings and generate a new one. For detailed information about obtaining API keys, API authentication, and available endpoints, refer to the SendGrid API documentation.

Create a SendGrid Credential​

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

New Credential Overlay – SendGrid

SendGridCred.png

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 Authentication​

SendGrid uses API key authentication for all API requests. The API key is sent in the Authorization header with the Bearer prefix to authenticate API requests to the SendGrid API.

  1. Enter your SendGrid API key in the SendGrid API Key field. This is the API key you obtained from your SendGrid account settings (Settings > API Keys or Account > API Keys). The API key is sent in the Authorization: Bearer {key} header for all API requests to the SendGrid API. The API key is sensitive information and must be kept confidential.

    Your SendGrid API key can be found in your SendGrid account settings under Settings > API Keys or Account > API Keys. The API key is sent in the Authorization: Bearer {key} header for all API requests to the SendGrid API.

    If your API key is compromised, you should immediately revoke it in your SendGrid account settings and generate a new one. The API key provides access to your SendGrid account data and should be treated as sensitive information. Keep your API key secure and do not share it publicly.

    For detailed information about obtaining API keys, API authentication, and available endpoints, see the SendGrid API documentation.

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.