SendGrid Integration Setup
Getting Started
Use this guide to connect SendGrid to your BalkanID tenant. You will need an API key from SendGrid and access to the Integrations section in BalkanID.
Requirements:
Before you begin, collect the following value from SendGrid:
API Key
Configure SendGrid within your BalkanID tenant
To create the API Key, sign in to SendGrid at https://app.sendgrid.com with an account that can manage API keys.
Navigate to Settings > API Keys, then click Create API Key.
Enter a name for the key and choose Custom Access. Give read access to Teammates, Subusers and User Account (see Integration Scopes below), then click Create & View.
Copy the key straight away. SendGrid shows it only once — if you lose it you will need to create a new key.
In BalkanID, go to Integrations and click Add integration.

Search for SendGrid, select it, then click Next.

Under Data Sync Preferences, choose the entity types you want BalkanID to sync. Everything supported is selected by default. Users are always synced and cannot be deselected, and the relationships between the types you select are synced for you.

Under Select Extraction Type, choose Direct Configuration, then paste the key you copied into API Key.

Click Next to move onto Optional Configuration.
Fill Optional Configuration, if required.

Once you have filled in the information, click Save. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read Connected and the integration Message will read Data available.
Integration Scopes
Teammates (Read) — the teammates on your account, the permissions each one holds, and invitations that have been sent but not yet accepted.
N/A
Subusers (Read) — your subusers, and which teammates can act on each one.
N/A
User Account (Read) — the account name, used to label the access BalkanID reads.
N/A
BalkanID checks what the key is allowed to read before it starts, and skips anything it cannot reach. A key with fewer permissions produces a smaller picture of your account rather than a failed sync, so you can start narrow and widen it later.
A teammate's role in SendGrid is one of Owner, Admin or Teammate. BalkanID reviews the role alongside the individual permissions granted with it, so a teammate on a long list of custom permissions is visible as more than just "Teammate".
Teammates who have been invited but have not yet accepted are shown as inactive users rather than being left out, so a pending invitation to a sensitive account is still something you can review and revoke.
Subuser access is kept separate from account-wide access. Where a teammate can only act on particular subusers, a review shows exactly which ones.
Last updated
Was this helpful?

