What’s supported
Supported actions
This connector supports:- Read Actions, including full historic backfill for all supported objects below. Incremental read is not currently supported.
- Write Actions (create/update/delete).
- Proxy Actions, using the base URL
https://api.sendgrid.com. - Subscribe Actions are not currently supported.
Supported objects
| Object | Read | Write | Subscribe |
|---|---|---|---|
| contacts | |||
| lists | |||
| segments | |||
| singlesends | |||
| templates | |||
| field_definitions | |||
| verified_senders | |||
| senders | |||
| bounces | |||
| blocks | |||
| spam_reports | |||
| unsubscribes | |||
| invalid_emails | |||
| asm_groups | |||
| categories | |||
| subusers |
Example integration
For an example manifest file of a SendGrid integration, visit our samples repo on Github.Before you get started
To connect SendGrid with Ampersand, you will need a SendGrid account. This connector uses API key authentication. You do not need to create a Provider App in Ampersand before getting started (Provider apps are only required for OAuth2 Authorization Code providers). Each customer supplies their own SendGrid API key during installation via the InstallIntegration UI component.Create a SendGrid API key
Follow SendGrid’s documentation to create an API key with the scopes your integration needs:- Log in to your SendGrid account.
- Go to Settings → API Keys.
- Click Create API Key.
- Choose Restricted Access and grant the minimum scopes required for your integration (for example, Marketing Campaigns for
lists, Template Engine fortemplates, and Suppressions forasm_groupsand suppression reads). - Copy the API key — SendGrid shows the full key only once.
Using the connector
To start integrating with SendGrid:- Create a manifest file like the example.
- Deploy it using the amp CLI.
- If you are using Read Actions, create a destination.
- Embed the InstallIntegration UI component. The UI component will prompt the customer for their SendGrid API key.
- Start using the connector!
- If your integration has Read Actions, you’ll start getting webhook messages.
- If your integration has Write Actions, you can start making API calls to our Write API.
- If your integration has Proxy Actions, you can start making Proxy API calls. Ampersand will automatically attach the customer’s API key.