SendGrid setup guide

Agents work with your audiences, campaigns and forms.

Ways to connect

Company admins connect apps, on the Integrations page in Everdeck: open SendGrid, choose one of the ways below, follow its steps and fill in its fields. Everdeck checks what you enter before it saves anything, and asks you to confirm it’s you (your second factor) before you type any secret. How connecting works.

API key

API key.

1. In SendGrid, open Settings > API Keys (https://app.sendgrid.com/settings/api_keys) and click Create API Key.
2. Name it "Everdeck" and choose Custom Access. Give Full Access to Mail Send and Marketing, and Read Access to Stats, Suppressions (including Unsubscribe Groups) and Template Engine (the scopes listed below). If SendGrid events should start agent work, also allow the Event Webhook settings (user.webhooks.event.settings.read and .update).
3. Click Create & View, copy the key (it starts with SG. and is shown once) and paste it here.
4. Pick EU only if the key belongs to an EU regional subuser.

Field	What to enter
Data residency (optional)	Choice: Global (api.sendgrid.com), EU regional subuser (api.eu.sendgrid.com). Starts as https://api.sendgrid.com/v3.
API key	A secret: Everdeck saves it encrypted and never shows it again. Where to find it.

The scopes Everdeck asks for:

• mail.send
• templates.read
• templates.versions.read
• stats.read
• suppression.read
• suppression.bounces.read
• suppression.blocks.read
• suppression.spam_reports.read
• suppression.invalid_emails.read
• suppression.unsubscribes.read
• asm.groups.read
• marketing.read

Disconnecting deletes the credentials Everdeck saved, but Everdeck can't revoke them: the key, token or password itself keeps working at SendGrid until you delete or rotate it there.

What agents can do

An agent uses an action only when its charter grants it, on the agent’s Tools tab, where you choose whether each one runs by itself (Auto), asks first or never runs. Each action has a risk tier: tier 3 actions, which customers or the public see, ask first unless you choose otherwise, and tier 4 actions (money, deleting things, access) always need a person. How tools and tiers work.

Actions marked Reads outside content return things people outside your company may have written. Agents treat what they read as information, never as instructions, and their riskier actions later in the same session need approval.

• Send an emailTier 3 · ExternalReads outside contentsendgrid_send_email

  Send an email to one or more recipients, from HTML you write (content) or from a dynamic template (template_id plus template_data). The from address must be a verified sender or on an authenticated domain.

• List email templatesTier 0 · ReadReads outside contentsendgrid_list_templates

  List dynamic email templates with their ids, version names and subjects, for use with send_email.

• Read email statisticsTier 0 · ReadReads outside contentsendgrid_get_email_stats

  Account-wide email statistics per day, week or month: requests, delivered, opens, clicks, bounces, blocks, spam reports and unsubscribes.

• Check why an address gets no emailTier 0 · ReadReads outside contentsendgrid_check_email_suppressions

  Check one email address against SendGrid's bounce, block, spam report, invalid email and unsubscribe lists, including unsubscribe groups. Use it when someone says they did not receive an email.

• Find marketing contactsTier 0 · ReadReads outside contentsendgrid_find_contacts_by_email

  Look up Marketing Campaigns contacts by exact email address (up to 100 at once), with their names, list ids, custom fields and dates.

• Create or update contactsTier 2 · Reversiblesendgrid_upsert_contacts

  Create or update Marketing Campaigns contacts, matched by email. Fields not sent stay as they are. Processing is asynchronous: the reply is a job id, and changes can take a few minutes to show. Does not add anyone to a list.

• Add contacts to listsTier 3 · Externalsendgrid_add_contacts_to_lists

  Add contacts (created if new) to one or more marketing lists. People on a list receive the Single Sends and automations aimed at it, so only add those who agreed to hear from you.

• List marketing listsTier 0 · ReadReads outside contentsendgrid_list_lists

  List Marketing Campaigns contact lists with their ids and contact counts.

• List Single SendsTier 0 · ReadReads outside contentsendgrid_list_single_sends

  List marketing email campaigns (Single Sends) with their ids, status (draft, scheduled or triggered) and send time.

• Draft a Single SendTier 2 · ReversibleReads outside contentsendgrid_create_single_send

  Create a draft marketing email for lists, segments or all contacts, with subject and HTML. Before it can be scheduled it needs a sender_id and either a suppression_group_id or a custom_unsubscribe_url. Nothing is sent until schedule_single_send.

• Send or schedule a Single SendTier 3 · Externalsendgrid_schedule_single_send

  Send a ready Single Send now (send_at "now") or schedule it for a future time. It goes to everyone it targets.

• Read Single Send resultsTier 0 · ReadReads outside contentsendgrid_get_single_send_stats

  Totals for a sent Single Send: requests, delivered, unique opens and clicks, bounces, spam reports and unsubscribes, combined across any A/B variations (ab_variation "all").

Testing, problems and disconnecting

Everdeck checks the connection when you save it. On the connection’s page in Integrations, Test checks it again at any time.

If SendGrid later refuses the connection, for example because a key was deleted or a sign-in expired, the connection shows Needs attention on the Integrations page and the people who manage connections are told. Agents can’t use it until a company admin fixes it with Edit.

To stop agents using SendGrid, open the connection and select Disconnect. Agents stop using it at once and its saved credentials are deleted. What else happens depends on how it was connected: each way above says.