SendGrid

The SendGrid connectorService used to define a connection required for associated actions and start events. Examples include Salesforce and Box. Method of integration to cloud services, business applications and content stores. is used to create connections for SendGrid actionsA tool for building the processes, logic, and direction within workflows.. Use SendGrid actions to interact with email, lists, and contacts within SendGrid.

Create a SendGrid connection

You can create connections from the Automate or Designer page.

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.

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

  1. On the top navigation bar, click Automate, and then select Connections from the left navigation.

  2. On the Connections page, click Add new.

  3. In the Add a new connection section that opens, fill in the following.

    In this field

    Select or enter the following
    Connector SendGrid

  4. Click Connect.

  5. In the Configure a connection window, fill in 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 SendGrid Settings - 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 SendGrid API Keys documentation.

  6. Click Connect.

  7. In the permissions dialog, you can do one of the following:
    • Edit the Owners or Users permissions according to data source usage requirements and click Save permissions.

      • Tip: You can assign connection owners or users permissions according to your access requirements. For more information, see Permissions.

Your new connection appears on the Connections page.

    • On the top navigation bar, click Automate > Workflows, and then select the required workflow.

      • (Or)

    • On the top navigation bar, click Automate > Create workflow.
  2. Click the SendGrid action you want to add the connection to, or drag a SendGrid action into the workflow and select it.

  3. In the drop-down list for Connection, select Add new connection.

  4. In the Connection window, fill in 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 SendGrid Settings - 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 SendGrid API Keys documentation.

  5. Click Connect.

  6. In the permissions dialog, you can do one of the following:
    • Edit the Owners or Users permissions according to data source usage requirements and click Save permissions.

      • Tip: You can assign connection owners or users permissions according to your access requirements. For more information, see Permissions.

Your new connection appears in the Connection field of your action.

Permissions

Permissions enable you to manage access for other users to use, edit, and delete connections.

  Use

Edit

 Delete

Assign
permissions

Owners
Users

Note: By default, users with administrator role will have the same rights as a Connection owner.

Follow these steps to assign permissions from the Connections page:

  1. On the Connections page, click for the required connection.
  2. From the menu, select Permissions.

    3. The corresponding permissions window is displayed.

  3. To assign permissions:
    • In the Owners field, type the name of the user, and select from the list.
    • In the Users field, type the name of the user, and select from the list.
  1. Click Save permissions.

Create an SendGrid data source

Use the SendGrid data source to create a drop-down list in a form for one of the following:

  • Retrieve a list of email addresses that bounced the sent message.
  • Retrieve a list of email addresses that are globally suppressed.
  • Retrieve marketing list names from the SendGrid account.
  • Search for contacts and retrieve their details for the SendGrid account.

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 control. The Data lookup control uses a SendGrid - Get global suppressions data source to list the suppressed emails.

You can create a data source to:

  • 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.

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

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

  1. Create your SendGrid data source.

    2. See Data sources.

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

Assign data source permissions

Permissions enable you to manage access for other users to use, edit, and delete data sources.

  Use

Edit

 Delete

Assign
permissions

Connection owners

Data source editors
Data source users

Note: By default, users with administrator role will have the same rights as a Connection owner.

Follow these steps to assign data source permissions from the Data sources page:

  1. On the Data sources page, click for the required data source.
  2. From the menu, select Permissions.

    3. The corresponding data source permissions window is displayed.

  3. To assign permissions:
    • In the Data source editors field, type the name of the user, and select from the list.
    • In the Data source users field, type the name of the user, and select from the list.
  1. Click Save Permissions.

SendGrid data source fields

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

Section

Field or selection

Description
Add new data source Operation Displays the operations available for the selected Connector. Depending on the selection the following fields are displayed:
  • Get global suppressions:
    • 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.
  • Search contacts: Use Segmentation Query Language (SGQL) to refine your search query. For example: email LIKE '%gmail.com'.