SendGrid

SendGrid is a cloud-based customer communication service for transactional and marketing email. The service manages various types of email including shipping notifications, friend requests, sign-up confirmations, and email newsletters. In the context of Nintex Workflow, SendGrid is a connector A software component that allows seamless integration with third-party services, business applications, and content stores. Examples include Salesforce, Box, and Microsoft SharePoint. Connectors are used to create connections required for workflow actions and start events. . The SendGrid connector is used to create connections for SendGrid actions A tool for building the processes, logic, and direction within workflows. Actions are the steps the workflow performs to complete a process.. Use SendGrid actions to interact with email, lists, and contacts within SendGrid.

For more information on SendGrid, see the SendGrid website.

Jump to:

Create a SendGrid connection

Note: Your browser-stored credentials are accessed to create connections. Either clear credentials from browser memory or make sure the stored credentials are for the intended environment.

Create a connection from the connections page or from the action configuration panel when configuring the action. For information about creating connections and assigning permissions, see Manage connections.

In the Add a new connection section, complete the fields as follows:

In this field

Select or enter the following
Connection name A name for your new connection
API Key A generated key a user with a valid account obtains from the SendGridSettings - API Key page. Always enter the word Bearer and a space before pasting your API key, for example: "Bearer SG.V6Ty...".
SendGrid uses API keys to authenticate access to SendGrid services. Different keys can have different access permissions. Before using the SendGrid connector, make sure the API key has been configured for the correct access level in SendGrid. For more information, see the SendGridAPI Keys documentation.

SendGrid account requirements

  • Nintex Workflow uses the Nintex Workflow - SendGrid Connector to create SendGrid connections. This connection requires you to grant the Nintex Workflow domain access to certain SendGrid data.
  • The SendGrid account used to generate the API key you use to create a connection to SendGrid, is the account that has access to the SendGrid actions.

Create a SendGrid data lookup

Use the SendGrid data lookup to create a drop-down list in a form to retrieve email addresses, marketing list names and contacts from SendGrid. For example, To allow users to select an email address that is in the SendGrid globally suppressed group, add a drop-down list of suppressed emails to the form using a Data lookup form control A form control that allow users to select from a drop-down list that has values sourced from a third-party service.. The Data lookupform control uses a SendGrid - Get global suppressions data lookup to list the suppressed emails.

Each data lookup is configured for a specific SendGrid connection. You can create as many data lookups as you need. For more information on creating a data lookup and assigning permissions to it, see Data lookups.

Each data lookup is configured for a specific SendGrid API key. You can create as many data lookups as you need.

Create a SendGrid drop-down list in a form

To add an SendGrid drop-down list to your form:

  1. Create your SendGrid data lookup.

    2. See Data lookups.

  2. Add a data lookup form control to your form and configure it to use your new data lookup.

SendGrid data lookup fields

When you create a SendGrid data lookup, you can configure some additional fields to refine what data the data lookup should retrieve.

To access the data lookup fields, in the Add data lookup section, select the Connector and the Operation.

The following operations are available to create a data lookup:

  • Get bounced email by email address: list email addresses that bounced the sent message.
  • Get global suppressions: list all email addresses that are globally suppressed.
  • Get marketing lists: list all the marketing list names.
  • Search contacts: list all contact details for contacts that match specified search terms.

The configuration fields displayed depend on the operation selected.

Operation

Field or selection

Description
Get global suppressions Connection The connection to use for the data lookup.
  Item limit The maximum number of items to return. Available choices are 10, 20, 50, and 100 items. The default is 100.
  Index The point in the list of global suppressions to start retrieving the email addresses. Type the value for the number of email addresses to skip at the start of the collection. For example, if you type a value of 2, the email address collection will start at the 3rd address in the list. This is useful when used with the Item limit field. If you set the item limit to 100, you can set the index to 99 which will return item 100 to item 199.
Get bounced emails Connection The connection to use for the data lookup.
Get marketing lists Connection The connection to use for the data lookup.
Search contacts Connection The connection to use for the data lookup.
  Search
  • Use Segmentation Query Language (SGQL) to refine your search query. For example: email LIKE '%gmail.com'.
    		•