Configuring Environment Variables
As a part of alert configurations for Twilio, Vonage, or SendGrid, you need to set up the environment variables for each provider on your machine. The following sections list the environment variables used in each notification provider.
To set up environment variables:
-
In the Windows search box, enter environment variables and open Edit the system environment variables with administrator privileges. The System Properties dialog opens.
Alternatively, select Edit environment variables for your account to open the Environment Variables dialog, and continue with step 3.
- On the Advanced tab, click Environment Variables to open the Environment Variables dialog.
- In the System variables section, click New to add an environment variable. Refer to the related section of this topic to learn more about variables for Twilio, Vonage, or SendGrid.
-
Enter the variable's name and value, and then click OK.
Environment variables are case-sensitive, so ensure that they are spelled correctly. - After adding or editing environment variables, click OK to close the Environment Variables dialog, and then restart the GENESIS Web API Service and GENESIS Alert Notifications REST Point Manager services.
-
If the services are on different machines, repeat this procedure on each machine, using the same values for the environment variables.
Twilio uses the following environment variables:
- Ico_Twilio_AccountSid: This is the account String Identifier (SID) associated with your Twilio account. You can find it on your Twilio account dashboard in the Account Info section.
- Ico_Twilio_AuthToken: This is the authentication token associated with your Twilio account. You can find it on your Twilio account dashboard in the Account Info section.
- Ico_Cfs_Username (preferred) or Ico_Twilio_UserName (in older versions of GENESIS): This is used for basic authentication of webhooks.
- Ico_Cfs_Password (preferred) or Ico_Twilio_Password (in older versions of GENESIS): This is used for basic authentication of webhooks.
Alternatively, you can create an API Key and use the API Key SID and Secret to add support for Twilio outgoing notifications only. To do this, add the following environment variables.
- Ico_Twilio_ApiKeySid: This is the API Key SID obtained from https://www.twilio.com/console/project/api-keys.
- Ico_Twilio_ApiSecret: This is the secret obtained from https://www.twilio.com/console/project/api-keys.
Vonage uses the following environment variables:
- Ico_Nexmo_Signature: This is the signature secret from the Signed webhooks section of the API Settings in your Vonage dashboard.
- Ico_Nexmo_Method: This is the signature method selected in the Signed webhooks section of the API Settings in your Vonage dashboard. The method is represented by a number based on the following list:
- MD5HASH = 0
- MD5 = 1
- SHA1 = 2
- SHA256 = 3
- SHA512 = 4
SendGrid uses the following environment variables:
- Ico_Cfs_Username (preferred) or Ico_Sendgrid_Username (in older versions of GENESIS): This is used for basic authentication of webhooks.
- Ico_Cfs_Password (preferred) or Ico_Sendgrid_Password (in older versions of GENESIS): This is used for basic authentication of webhooks.