SendGrid

The integration described in this guide uses webhooks to allow EPM to automatically send JIT Application notifications using SendGrid.

❗️

Third-party documentation is subject to change. Updates might not be reflected in BeyondTrust documentation. For the most up-to-date information, visit SendGrid.com.

Requirements

• Access to a BeyondTrust site with an EPM app
• An account with privileges to create webhook integrations
• Access to SendGrid with administrative rights to create API keys

For more information, see SendGrid Documentation.

Create a SendGrid API Key

1. Log in to the SendGrid app portal.
2. Click Email API > Integration Guide.
3. Click Choose under Web API.
4. Click Choose next to cURL.
5. Under Create an API Key.
6. Enter a key name.
7. Click Create Key.
8. Copy the API Key for later use in EPM.
9. Execute the curl command.
   This will send a email via the API for testing. You must use the validated email in the from address field.
10. Click I've executed the code above.
11. Click Next: Verify Integration.
12. Click Verify Integration.
    This will check to see if the email was sent properly.

Create a webhook integration for SendGrid

1. Go to EPM > Configuration.
   The Settings page displays the available system settings.
2. Click Webhook Settings.
   The Webhook Settings page displays.
3. Click Create Webhook.
   The Create Webhook page displays.
4. To create the webhook, use the following:
   • Webhook Name: Enter a name
   • Webhook URL: Enter SendGrid integration URL. (ie https://api.sendgrid.com/v3/mail/send)
   • Event: JIT Application Access Ticket Created
   • Content Type: application/json
   • Authentication Type: Custom
   • Token: Enter the integration API Key from SendGrid. Prepended by Bearer (for example, Bearer SENDGRID_API_KEY).
   • Template: Use the following test webhook JSON template to test the connection and send a webhook to SendGrid. After a successful test with the static test data, the template can be configured. Create or change the fields and add variables as per your requirements.

{
	"personalizations": [{
		"to": [{
			"email": "[email protected]"
		}]
	}],
	"from": {
		"email": "[email protected]"
	},
	"subject": "JIT Application Access Request",
	"content": [{
		"type": "text/plain", 
		"value": "A request to execute %%FilePathObjectId%% by %%User%% has been received. You can view the application at https://example.pm.beyondtrustcloud.com/jit-access-management/jit-access/details/%%RequestId%%"
	}]
}

📘

The from email address must be in the list of verified sender in SendGrid.

For more information, see SendGrid Documentation.