Skip to main content
Skip table of contents

SendGrid Email

SendGrid is a third-party email execution engine used by RPI to deliver interaction emails.

The following channel-specific fields are shown for SendGrid email channels:

  • Re-subscribe contacts: as per SFMC email channel.

  • Recipient email: as per SFMC email channel.

  • Service Credentials section, containing the following:

    • Web API URL: the URL of the API used to connect to the SendGrid service. Use of an HTTPS URL is supported in this context. The property defaults to ‘https://api.sendgrid.com/’.

    • API key: this text field is mandatory. It accepts a maximum length of 100 characters. It represents the API key that will be used by the channel to connect to the SendGrid service. Note that the supplied API key must have the ‘Full Access’ API key permission.

    • API key ID: this text field is shown and enabled when Web API version is set to v3, in which case it is mandatory. It accepts a maximum length of 100 characters. It represents the API key ID that accompanies the provided API key, and which will be used by the channel to connect to the SendGrid service.

  • Suppressions section, containing the following:

    • Auto-suppress: as per SFMC email channel.

    • Custom suppression table: as per SFMC email channel.

    • Suppression table name: as per SFMC email channel.

  • SMTP Details section, containing the following:

    • Use SMTP: this checkbox is unchecked by default. If checked, an SMTP connection will be used when sending emails. If unchecked, the SendGrid Web API v3 will be used instead.

    • SMTP server: the SMTP (Simple Mail Transfer Protocol) server used by the SendGrid service.

    • SMTP port: the port used at the aforementioned server.

    • SMTP username: this mandatory text property accepts a maximum of 100 characters, and defaults to the value 'apikey'. It allows you to specify the SMTP username to be used to connect to the SendGrid SMTP service.

    • SMTP timeout: the SMTP send call timeout (in milliseconds). This numerical field is mandatory and must be a value between 1 and 999,999,999. The value is set to 300,000 by default.

    • Use SMTP relay: this checkbox is unchecked by default. When checked, it specifies that the channel should use the SendGrid SMTP relay (which is designed for use by high volume senders).

      • SMTP authentication: this property is only enabled when Use SMTP relay is checked. It represents the type of authentication to be used to connect to the SendGrid SMTP relay service.

A dropdown list, it exposes the following values:

  • Anonymous (the default)

  • Credentials

  • Windows Integrated

  • Username: this property is only enabled when Use SMTP relay is checked, and when SMTP authentication is set to Credentials. The textbox is mandatory when enabled and accepts a maximum value length of 100 characters. It represents the user name that will be used to connect to the SendGrid SMTP relay service.

  • Password: this property is only enabled when Use SMTP relay is checked, and when SMTP authentication is set to Credentials. The password-masked textbox is mandatory when enabled and accepts a maximum value length of 100 characters. It represents the password to be used to connect to the SendGrid SMTP relay service.

  • Campaign Category section, containing the following:

    • Use campaign category: this checkbox is unchecked by default. If checked, one or more category names will be used as part of an email campaign. When an email offer is executed using a channel at which Use campaign category is checked, configured category names will be substituted with runtime values, and will be reflected as Category names for the email campaign in SendGrid. Note that, if using SendGrid’s Categories feature, there exists the potential for execution performance to be compromised.

    • Category names: this property consists of a toolbar and a list.

      • Toolbar: exposing a single button:

        • Click here to design category format: clicking this button displays the Design Category Name Format dialog.

The dialog is based on the standard RPI Design Format dialog and allows you to select text parts from which category names will be constructed. An example is shown at the bottom of the dialog. Clicking Close, or clicking off the dialog, closes it.

List: at least one, and a maximum of ten, custom category name formats can be supplied. Duplicates are not permitted. An inline Remove button is available at each list entry.

  • Callback Service section, containing the following:

    • Callback service URL: a public-facing service to which SendGrid will post state and metric data. The value entered should be the same as the Post Event URL configured in the SendGrid account's Event Notification app, which must be enabled to facilitate the return of results from SendGrid. Use of an HTTPS URL is supported in this context.

    • Events external folder: clicking this button displays the Events External Folder dialog, in which you can select an external folder to which SendGrid event details will be written. The AWS S3 Azure Storage and FTP external content providers can be used to host such a folder. When an Events external folder is provided, email results are imported from the external folder.

    • Configuration: this button allows you to copy the JSON configuration used at the SendGrid Callback service settings' ExternalContentProviderSettings section to the clipboard. It is enabled when an Events external folder has been selected.

    • Process older event files first: this checkbox is unchecked by default. If checked, RPI will prioritize the processing of older event files first.

  • List Unsubscribe (optional) section, containing the following:

    • Email unsubscribe: this text property, which is blank by default and which can be a maximum of 100 characters in length, allows you to specify the mailto portion of the List-Unsubscribe header that will receive unsubscribe requests. Email unsubscribe is mandatory when Web unsubscribe is provided. It must be set to a valid email address.

    • Email unsubscribe subject: this optional text property accepts a maximum of 1000 characters. It allows you to specify the email unsubscribe subject parameter to be used for the mailto portion of the List-Unsubscribe header. If provided, Email unsubscribe must also be set.

When emails are sent and both properties are set, the 'List-Unsubscribe' header will be populated using the following format:

<mailto:[Email unsubscribe]?subject=[Email unsubscribe subject]>

Web unsubscribe: this text property, which is blank by default and which can be a maximum of 1000 characters in length, allows you to specify the http portion of the List-Unsubscribe header that will receive a POST whenever someone clicks an unsubscribe link in an email. It must be set to a valid URL.

Note that configured Email and Web unsubscribe settings take effect only when SendGrid subscription tracking is disabled.

  • Miscellaneous section, containing the following:

    • Remove footer: as per SFMC email channel.

    • Disable click track: this checkbox is unchecked by default. If checked, URL click tracking is disabled at the current channel.

    • Disable open track: this checkbox is unchecked by default. If checked, Open tracking is disabled at the current channel.

    • Max send batch size: this integer property represents the maximum number of recipient records that can be sent at a single time to SendGrid. It defaults to 1000, which is also the minimum supported value, and accepts a maximum value of 10,000.

    • Max send thresholds: this mandatory integer property defaults to 10, and can be set to between 1 and 10. It represents the maximum number of concurrent send operations that can be executed for a batch of email campaigns. At email offer activity execution, SendGrid email campaigns will be grouped as a batch based on identical content sets (such as HTML, Text and subject line). Batches of email campaigns can be sent in parallel in accordance with the value set at the property. Batch of email campaigns are processed based on the total number of batches/Max send thresholds. If the total number of batches is less than or equal to Max send thresholds, only a single send operation is performed. Details of send operations are available in the activity Log via the Results Window.

    • BCC email address: as per SFMC email channel.

    • Event import batch size: this mandatory integer property defaults to the value 10,000. It accepts a minimum value of 5,000 and a maximum value of 20,000. It represents the maximum number of email events that can be imported into SendGrid in a single batch. If more events than the stipulated value need to be processed, they are handled in separate batches.

    • Save mail merge files: this checkbox is unchecked by default. When checked, SendGrid mail merge files will be persisted on the RPI server, in a location defined by the Mail merge external folder property. If checked, a warning message is shown:

At channel execution when the property is checked, generated mail merge files will be saved to the specified external folder.

  • Mail merge external folder: this property is enabled when Save mail merge files is checked. When enabled, you must select an external folder to which to save mail merge files.

  • API rate limit max. re-try: this mandatory numeric property, which defaults to 30, allows you to specify the number of retries to be attempted if a rate limit is hit when making calls to a SendGrid API.

  • Use secondary password: this checkbox is unchecked by default. If checked, a secondary password will be used to validate each HTTP request against whitelisted IP addresses.

  • Secondary password: this password-masked text field is enabled and mandatory when Use secondary password is checked. It allows you to specify a secondary password to be used to connect to SendGrid.

  • Fail if no mail merge files: this checkbox is unchecked by default. If checked, execution using the channel will fail in the event of no mail merge files being generated.

  • Use open-track pixel: this checkbox is unchecked by default. If checked, a single '%open-track%' pixel must be provided in HTML content (a runtime validation error being raised if this is not the case).

  • Custom headers: this property allows you to specify custom header values to be sent with emails executed using the channel. It consists of a header and a list.

    • Header: exposing the following:

      • Add: invocation adds a new custom header to the list.

      • Remove: invocation removes the currently-selected header from the list without display of an 'Are You Sure?' dialog.

    • List: lists custom headers associated with the channel. For each, are displayed:

      • Custom header name: mandatory, and a maximum of 100 characters in length.

      • Custom header value: mandatory, and a maximum of 100 characters in length.

      • Remove: inline button. Invocation removes the currently-selected header from the list without display of an 'Are You Sure?' dialog.

The following settings are available at the Advanced tab:

  • External folder: as per Acoustic email channel.

  • Request timeout: this property is set to a default value of 60 and accepts a minimum value of 3. It represents, in minutes, the amount of time for which an activity will wait for API requests to complete. At execution of an email offer in an interaction workflow, or a channel synchronization job, RPI will continue to send requests to SendGrid until a successful response is received or timeout period elapses.

  • Enable trace: this checkbox is unchecked by default. When checked, API requests and corresponding replies from the email service provider are logged. At execution of an email offer in an interaction workflow, or a channel synchronization job, if checked, all requests made to SendGrid are logged. Note that this feature should be used only when troubleshooting to avoid logging an excessive amount of data to the database.

Note the following message, which is displayed when the property is checked:

Note also, when Enable trace is checked at a SendGrid channel, copies of any related MailMerge files will be created and stored at C:\temp\RPI\Emails\SendGrid\.

  • Move hashtags to end of URL: as per Salesforce Marketing Cloud email channel.

  • Personalized content queue: you must select a queue provider to which generated content will be sent before being email fulfillment takes place. Note that the queue is not used at execution via a queue listener or when sending test emails from the email Offer Designer.

  • Personalized content queue path: this mandatory text property allows you to specify the queue provider path to which generated content will be sent.

Note that Web Adapters are supported at the channel.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close