SendGrid

SendGrid is a cloud-based platform intended for delivering transactional and marketing emails.

Data integration: Skyvia supports importing data to and from SendGrid, exporting SendGrid data to CSV files, replicating SendGrid data to relational databases, and synchronizing SendGrid data with other cloud apps and relational databases.

Backup: Skyvia Backup does not support SendGrid.

Query: Skyvia Query supports SendGrid.

Establishing Connection

To create a connection to SendGrid, you need to specify an API Key.

Getting Credentials

To get your API Key, perform the following steps:

1. Sign in to SendGrid.

2. Click Settings in the menu on the left.

   

3. In the drop-down list, click API Keys and copy your API Key.

4. If you don’t have an API Key in your SendGrid account yet, you need to create it and select API Key permissions.

   

Creating Connection

Paste the obtained API Key to the corresponding box in the Connection Editor.

Additional Connection Parameters

Use Custom Fields

Select this checkbox to make custom fields available in Skyvia.

Connector Specifics

Object Peculiarities

Contact

Due to SendGrid API peculiarities, the INSERT and UPDATE operations work the following way. When you import a record with an existing Email value, the integration updates the corresponding target record. When you import a record with a new Email value, the integration inserts a new record to the target.

It takes several minutes for changes to display in the Contact object.

The ListIds field supports the INSERT operation and does not support the UPDATE operation. To update the ListIds field, you can use the Insert action, map the existing value to the Email field and map the ListId field.

EmailStatistics Objects

To get data from the -EmailStatistics objects (GlobalEmailStatistics, EmailStatisticsByCountry, EmailStatisticsByDeviceType etc.), you must set the filter by StartDate with = (equals) operator only. Optionally, you can add the filter by EndDate. StartDate and EndDate fields are used for filtering only and do not display values when querying.

Suppressions

To import data to the Suppressions object, map the Email field to the values in the array format, for example: ["test1@example.com","test2@example.com"]

Custom Fields

When you get the data from the CustomFields field of the Contacts object, the data is returned in form of a JSON array with pairs of “custom field name”:”custom field value”.

To successfully import data to custom fields, you must pass the custom field Id instead of name, in the following format: “custom field Id”:”custom field value”.

DML Operations Support

Incremental Replication and Synchronization

Skyvia supports Replication with Incremental Updates selected for SendGrid objects, which have either the UpdatedDate or CreatedDate field. Thus, such objects as Alerts, Blocks, Bounces, Contacts, ContactListRecipients, Designs, DesignsPre-built, InvalidEmails, Senders, Segments,SingleSends, SpamReports, Suppressions, Templates, TransactionalTemplateVersions, Unsubscribes can be replicated with incremental updates.

Skyvia supports Synchronization for such SendGrid objects as Alerts, Designs, Segments, Senders, SingleSends, Templates, TransactionalTemplateVersions.

Stored Procedures

Skyvia represents part of the supported SendGrid features as stored procedures. You can call a stored procedure, for example, as a text of the command in the ExecuteCommand action in a Target component of a Data Flow or in Query.

If you want to omit the unnecessary parameters, specify the empty value '' for text or null for numbers.

MailSend

To send emails using SendGrid API, use the command

call MailSend(:Personalizations, :FromEmail, :FromName, :TemplateId, :ReplyToEmail, :ReplyToName, :ReplyToList, :Subject, :Content, :Attachments, :Headers, :CustomArgs, :Categories, :SendAt, :BatchId, :Asm_GroupId, :Asm_GroupsToDisplay, :IPPoolName, :MailSettings_BypassListManagement_Enable, :MailSettings_BypassSpamManagement_Enable, :MailSettings_BypassBounceManagement_Enable, :MailSettings_BypassUnsubscribeManagement_Enable, :MailSettings_Footer_Enable, :MailSettings_Footer_Text, :MailSettings_Footer_HTML, :MailSettings_SandboxMode_Enable, :TrackingSettings_ClickTracking_Enable, :TrackingSettings_ClickTracking_EnableText, :TrackingSettings_OpenTracking_Enable, :TrackingSettings_OpenTracking_SubstitutionTag, :TrackingSettings_SubscriptionTracking_Enable, :TrackingSettings_SubscriptionTracking_Text, :TrackingSettings_SubscriptionTracking_HTML, :TrackingSettings_SubscriptionTracking_SubstitutionTag, :TrackingSettings_GAnalytics_Enable, :TrackingSettings_GAnalytics_UtmSource, :TrackingSettings_GAnalytics_UtmMedium, :TrackingSettings_GAnalytics_UtmTerm, :TrackingSettings_GAnalytics_UtmContent, :TrackingSettings_GAnalytics_UtmCampaign)

Personalizations value example with template:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[{
    "to": [{
            "email": "alex@example.com",
            "name": "Alex"
        },
        {
            "email": "bola@example.com",
            "name": "Bola"
        }
    ],
    "dynamic_template_data": {
        "subject": "Hello, Alex",
        "customer_name": "Alex",
        "confirmation_number": "123abc456def789hij0"
    }
}]

Personalizations value example without template:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
[{
        "to": [{
                "email": "alex@example.com",
                "name": "Alex"
            },
            {
                "email": "bola@example.com",
                "name": "Bola"
            }
        ],
        "cc": [{
            "email": "charlie@example.com",
            "name": "Charlie"
        }],
        "bcc": [{
            "email": "dana@example.com",
            "name": "Dana"
        }]
    },
    {
        "from": {
            "email": "sales@example.com",
            "name": "Example Sales Team"
        },
        "to": [{
            "email": "ira@example.com",
            "name": "Ira"
        }],
        "bcc": [{
            "email": "lee@example.com",
            "name": "Lee"
        }]
    }
]

Command example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
call MailSend(
  '[
    {
      "to": [
        {
          "email": "alex@example.com",
          "name": "Alex"
        },
        {
          "email": "bola@example.com",
          "name": "Bola"
        }
      ],
      "dynamic_template_data": {
        "subject": "Hello, Alex",
        "customer_name": "Alex",
        "confirmation_number": "123abc456def789hij0"
      }
    }
  ]', 
  'annak@rndwork.com', 'DecsCorp', 
  'd-7c8108b5268e4ac1a4b08ba0aef0a472', 
  null, null, null, null, null, null, 
  null, null, null, null, null, null, 
  null, null, null, null, null, null, 
  null, null, null, null, null, null, 
  null, null, null, null, null, null, 
  null, null, null, null, null, null
)

Supported Actions

Skyvia supports all the common actions for SendGrid.