For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

  1. To create the API Key, sign in to SendGrid at https://app.sendgrid.com with an account that can manage API keys.

  2. Navigate to Settings > API Keys, then click Create API Key.

  3. 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.

  4. Copy the key straight away. SendGrid shows it only once — if you lose it you will need to create a new key.

  5. In BalkanID, go to Integrations and click Add integration.

The BalkanID Integrations page, with the Add integration button at the top right of the toolbar
Integrations page, with Add integration
  1. Search for SendGrid, select it, then click Next.

Step one of the Connect a new application wizard with SendGrid searched for and selected
SendGrid selected in Connect a new application
  1. 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.

The Data Sync Preferences panel showing the Users, Roles and Subusers entity types and the required API scopes
Data Sync Preferences and the required API scopes
  1. Under Select Extraction Type, choose Direct Configuration, then paste the key you copied into API Key.

The Direct Configuration section of the wizard showing the API Key field
Direct Configuration credential field
  1. Click Next to move onto Optional Configuration.

  2. Fill Optional Configuration, if required.

The Optional Configuration step, showing reviewer settings on the left and fulfillment options on the right
Optional Configuration
  1. 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

Read Only Scopes
Lifecycle Management 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?