Overview
This guide outlines the steps to integrate Sendgrid on the App Catalog page in Josys.
- If you have configured IP address access restrictions, please configure your settings to allow access from Josys.
Integration Specifications
| Target Plans | Free, Essentials, Pro, Premier, Basic, Advanced |
|---|---|
| Required Admin Role | owner |
| Integration Method | API Key/Token |
| Integration Key | |
| Supported Features | Account Deletion Account Visualization Licenses Visualization Role Change |
| Account Visualization Statuses | Pending Active Deleted |
| Statuses Excluded from Unmanaged IDs | Deleted |
| Available Settings upon Provisioning | |
| Available Settings upon Deprovisioning | |
| Contract Information | How to Check Contract Information |
| Visualized Fields | ・Status |
| Licenses Management Fields | Total Licenses Assigned Unassigned |
| Common Fields | Status User |
| Role Edit |
Generating an API Token
- Log in to Sendgrid with an administrator account.
Go toSettings > API Keysin the menu, then clickCreate API Key. - Create the API Key with
Full Accessand copy it.
If you wish to integrate using permissions other than
Full Access💡 On the Sendgrid UI, creating an API key with only the Teammates permissions required by Josys is not supported.
If you wish to integrate using an API key with restricted permissions, you will need to create the API key via Twilio's REST API.The steps are as follows:- Create a Full Access API key from the UI.
- Based on the API key from step 1, create an API key with restricted permissions.
- Enter that API key when integrating with Josys.
For step 2, please run the following command in Terminal (Mac) or Command Prompt (Win) (replace
{FULL_ACCESS_API_KEY}with the key created in step 1):curl -X POST "https://api.sendgrid.com/v3/api_keys" \ --header "Authorization: Bearer {FULL_ACCESS_API_KEY}" \ --header "Content-Type: application/json" \ --data '{"name": "Josys", "scopes": ["teammates.read"]}'Create API keyshttps://docs.sendgrid.com/api-reference/api-keys/create-api-keys
(Optional) Configuring Subusers
If you want to integrate with Josys using a subuser, you need to configure the subuser name during integration.
The subuser name can be found in the parent account under Settings > Subuser Management.
💡 What is a subuser?
A subuser is a "child account" linked to a parent account.
Access information to SendGrid and sending limits can be configured individually for each subuser.
Access information to SendGrid and sending limits can be configured individually for each subuser.
A Pro plan is required to use this feature.
For more details, please refer to:
→ Creating/Managing Subusers
For more details, please refer to:
→ Creating/Managing Subusers