Email Beacon configuration

To get started please go to Settings > Settings > Beacons and click on the NEW INTEGRATION button.

Select Uptime Monitoring Service as the Beacon Type and give your Beacon a name.

Then a setup walk through will show to help you set the beacon type, provider and other settings. Instead of selecting generic webhook, or an integrated third-party, you will select generic e-mail.

Once you submit the walk-through you will be taken to the beacon configuration area, which is made up of several sections. The most important sections, for the purposes of this article, are the General and the Rules section. Note: Here you can also see historical information about the beacon and incidents related to it.

The beacon will show the email to be used for integration in the Forwarded emails to section.

For the most part, in general, email beacons are setup to evaluate information in a ping from a service to see if a service is up or down and then execute the action or actions specified. To do this, the beacon should grab the necessary information to see if the conditions are met. If the service is down, create an incident. If the service is up, create an update.

The two macros used for the Email beacon are:

• $.subject - The subject of your Email
• $.content - The body of your Email

Before you can utilize this beacon fully, custom variables will need to be added to your beacon to pull the email content.

Adding Your Variables

Feel free to use our example names to model your variables after:

1. Name your VARIABLE subject

2. Enter your VALUE as $.subject

3. Keep the VARIABLE as value

4. Name your next VARIABLE $.content

Setting Up Your Beacon

To begin setting up the Email Beacon, take a look at the example ruleset:

Check the checkbox on Create Incident.

1. Select the Subject IDENTIFIER.

2. Select Contains as the CRITERIA OPERATOR. (ex. "Service B is Down")

3. Enter an identifying key that will be found in the email Subject.

4. Set an Incident Type and Status.

In the message field, enter {{@content}} to create the incident with information pulled from the email body. This will utilize the created variable from above.

Check the checkbox next to Update Incident.

1. Select the Subject IDENTIFIER.

2. Select Contains as the CRITERIA OPERATOR. (ex. Resolved)

3. Enter an identifying key that will be found in the email.

4. Click Update.

Your Email Beacon is now ready for use. Simply have your integrated component send emails to the address listed in the Forwarded emails to section.