Setting Up SendGrid

First, go to https://signup.sendgrid.com/ and sign up for a SendGrid account. You can choose different packages based on your requirements. Go to https://app.sendgrid.com/settings/api_keys create and copy the APIKey. We will need this in step 5.

1. In the Workbench Project Explorer, go to Alarms and Notifications > AlertWorX > SendGrid Configurations. Right-click and choose Add SendGrid Configuration, as shown below.

Adding SendGrid Configuration from the Project Explorer in the Workbench

2. Check the “Is Default Configuration” box at the top to set the configuration as default.

3. Add a Description (optional).

4. Add a Default From address. You may have to verify the From address before you can use it. See https://sendgrid.com/docs/ui/sending-email/sender-verification. This will be used as default when calling methods with no from fields (SendEmail and SendEmailWithAttachments). This field is mandatory for setting the configuration.

5. Copy the initially created API Key to the API Key field. Ensure that the AlertWorX service is running and click on the Verify Key button. The Verify Key button should become disabled if it is successfully verified. This process ensures that the integration with SendGrid is done successfully.

Note: SendGrid recommends that you use an APIKey with all permissions for proper verification of your Key. You may otherwise get error saying:Forbidden.

Verification Success Notification

6. You can check the Enable Reply To check box and provide a different email ID for the recipients to reply to. This is especially useful if you want to set up a new domain which parse acknowledgments. By default, the ‘Reply To’ field is set to be the From address itself.

7. Apply the changes. Now, in the Data Browser, you can see the methods supported by SendGrid

SendGrid Supported Methods

8. You can use the "Test Email" button in the configuration to test that a message gets sent successfully once the configuration is applied successfully as above. Clicking it will open the "Send a test message" window.

Set up the To address, Subject, and Message, along with optional fields Cc, Bcc, Attachment Path, etc., in the Notification Message tab. You may have to verify the From address before you can use it. See https://sendgrid.com/docs/ui/sending-email/sender-verification.

You can add multiple recipients using a ‘;’ delimiter. You can also mention the name of the recipient with a ‘,’ delimiter. For example, ‘user1@domain.com,User1Name;user2@domain.com, User2Name’. This is possible in the To, Cc and Bcc fields.

Multiple attachments are also supported (up to 10) by use of a ‘;’ delimiter. The service should have permission to access the file. If any one of the attachments cannot be attached by process, the email will not get sent. The whole file name should be present for identifying purposes.

Sending a Test Message