SendGrid Acknowledge Support in CFSWorX Workflow

To Enable Acknowledgement via Email:

Have a default SendGrid Configuration set up.
Ensure that ‘Enable Email Alert ID’ is checked.

Enable Email Alert ID Setting

In the SendGrid dashboard, go to: https://app.sendgrid.com/settings/parse and click Add Host and URL. Clicking on this will ask you to add Domain Authentication. You can read more about this here: https://sendgrid.com/docs/for-developers/parsing-email/setting-up-the-inbound-parse-webhook/. You can set up a new domain for this purpose or subdomain your existing domain for inbound parse. You should never use the existing mail domain for this because this would parse the entire e-mails coming to this domain, which probably includes confidential emails and should be avoided.

Once domain authentication is done, you can add the subdomain and set reply webhook under Destination URL as https://username:password@yourdomain/fwxapi/sendgrid/email/inbound

Note: When constructing the URL above, "username” and “password” should match the values of the Ico_Sendgrid_Username and Ico_Sendgrid_Password environment variables respectively, and “domain” is the domain where the WebAPI service is running.

The Reply To field should have an email id with the subdomain you set up in your parse setting above. For example, if your subdomain was “sub” and main domain was “mainDomain”, the Reply To email would look something like abc@sub.mainDomain.com or rst@sub.mainDomain.com.

The reply format expected is AlertID AcknowledgeID OptionalComment followed by a carriage return or new line. The new line after the reply format is important to process acknowledgement.

Note: Acknowledge Code could be the default Acknowledge Code configured for the workflow configuration of CFSWorX or BridgeWorX, in case the worker does not have an acknowledge code assigned. BridgeWorX does not currently support the Worker Lookup activity so it will always need to use the default Acknowledge Code.

For example:

23 A123Z Acknowledging alarm at pump house 1

Make sure to use the CFSWorX workers list for acknowledge by using the 'Worker Lookup’ activity in CFSWorX before using 'Send SendGrid Email' activity.

Unsubscribe option from SendGrid

To add Un-subscribe link via SendGrid UI, Goto https://app.sendgrid.com/settings/tracking , Click on 'Subscription Tracking. You can customize the unsubscribe settings such as choosing a default landing page and customizing the unsubscribe links. You can also choose SendGrid default landing page. More details can be found here: https://docs.sendgrid.com/ui/sending-email/subscription-tracking.

If a user clicks on unsubcribe, they are added to the global unscubscribe list found here: https://app.sendgrid.com/suppressions/global_unsubscribes and further emails are blocked from being sent from SendGrids end.

You can add/remove the users who shouldn't get the emails by going to the global unsubscribe page above and removing users there.

Please note: If the emails are marked Spam or risky for phishing, the unsubscribe link may become unclickable. This is done by the e-mail providers and sometimes moving to inbox will enable such links.