Managing Events Events / Managing Events

Event communication is one of the primary features of StatusDashboard.  Events are service disruptions or degradations (either planned or unplanned) that impact the services you display on your dashboard.  It is critical that you create and update events in a timely fashion and communicate status effectively with your customers and users, and StatusDashboard gives you the tools to facilitate that interaction.

There are two types of events in StatusDashboard, incidents and scheduled maintenance.  Incidents are typically unplanned service disruptions and scheduled maintenance events are service disruptions that are known and scheduled in advance.  To create events, navigate to Events > Create [Incident | Maintenance] and complete the relevant fields.  The list of fields and options related to events are detailed below. All fields may be updated after the event is created.

Field

Event Type

Required

Description

Start Date

All

Yes

The start date of the event, shown in the timezone of the user creating the event. Incident events may not have start dates/times in the future.

Start Time

All

Yes

The start time of the event, shown in the timezone of the user creating the event. Incident events may not have start dates/times in the future.

End Date

All

Depends

The end date of the event, shown in the timezone of the user creating the event. This field is optional for incident events and when excluded, indicates that the incident is still open. This field is required for maintenance events.

End Time

All

Depends

The end time of the event, shown in the timezone of the user creating the event. This field is optional for incident events and when excluded, indicates that the incident is still open. This field is required for maintenance events.

Description

All

Yes

The description of the event.

Status

All

Status is set automatically for incident events based on the presence/absence of an end date/time.

Yes

The current status of the event.

Open

Incident events only.

The incident event is currently active. The status of all selected services on the dashboard, event emails and API will indicate that an incident is active.

When an incident event is created without an end date/time, it is automatically placed into the Open state.

Closed

Incident events only.

The incident event has been resolved. The status of all selected services on the dashboard, event emails and API will indicate that the services are operational (as long as there are no other active incidents or scheduled maintenance events affecting the services).

Once an end date/time is added to an event and saved, the incident is automatically moved to the Closed state.

Planning

Maintenance events only.

The maintenance event is being planned. The status of all selected services on the dashboard, event emails and API will be shown as operational (as long as there are no other active incidents or scheduled maintenance events affecting the services).

Started

Maintenance events only.

The maintenance event has started. The status of all selected services on the dashboard, event emails and API will be shown in maintenance mode (unless there is an active incident affecting the same services, in which case the services will be shown as having an active incident).

Completed

Maintenance events only.

The maintenance event has been completed. The status of all selected services on the dashboard, event emails and API will be shown as operational (as long as there are no other active incidents or scheduled maintenance events affecting the services).

Markdown

All

No

When enabled, any text entered in the description field (and any event updates), will be rendered using markdown on all dashboard pages and event emails for that particular event. Caution should be used when enabling markdown as the resultant HTML could have unintended consequences in terms of distorting the dashboard or HTML formatted event emails. Additionally, markdown will be displayed in dashboard RSS/ATOM feeds as well as API calls to the /event/list/ endpoint so your clients should be aware.

The following markdown tags are safe to use with StatusDashboard. Your experience may vary when using other tags:

Links

Use square brackets to delimit the text you want to turn into a link, followed by parentheses around the target link, like this:

This is an [example link](http://example.com/).

Which produces the following in the resultant dashboard or email display:

  
<p>This is an <a href="http://example.com/">example link</a>.</p>
  

Emphasis

Emphasis is created using asterisks and underscores to indicate spans of emphasis, like this:

Some of these words *are emphasized*.
Some of these words _are emphasized also_.

Use two asterisks for **strong emphasis**.
Or, if you prefer, __use two underscores instead__.

Which produces the following in the resultant dashboard or email display:

  
<p>Some of these words <em>are emphasized</em>.
Some of these words <em>are emphasized also</em>.</p>

<p>Use two asterisks for <strong>strong emphasis</strong>.
Or, if you prefer, <strong>use two underscores instead</strong>.</p>
  

Unordered Lists

Unordered (bulleted) lists use asterisks, pluses, and hyphens (*, +, and -) as list markers. These three markers are interchangable, like this:

* one
* two
* three

+ one
+ two
+ three

- one
- two
- three

Which produces the following in the resultant dashboard or email display:

  
<ul>
  <li>one</li>
  <li>two</li>
  <li>three</li>
</ul>
  

Ordered Lists

Ordered (numbered) lists use regular numbers, followed by periods, as list markers:

1. one
2. two
3. three

Which produces the following in the resultant dashboard or email display:

  
<ol>
  <li>one</li>
  <li>two</li>
  <li>three</li>
</ol>
  

Event Visibility

All

No

Control whether or not the event is visible in different areas of the admin or dashboard. When any of the toggle buttons are selected, the event will be excluded from that specific feature.

Impact Analysis

Maintenance

No

Any potential or expected consequences of the event may be listed here.

Maintenance Coordinator

Maintenance

No

If a particular individual or team member will be responsible for coordinating the event, their contact details may be listed.

Services Impacted

All

Yes

A listing of all services that are impacted by the event.

Automatic Start/End

Maintenance

No

When enabled, we'll automatically start and end your event based on the times for the event that you have selected. We'll also trigger any notification methods that you have set in your default notification options when we start and end the event. Note that your start/end times must have seconds equal to '00' in order for us to start/end the event.

Notifications

All

No

We support a number of notification methods for alerting users about events.  The following integrations are currently supported for notifying users whenever events are created or updated. Each time you update the event, you can select which notification methods you want to activate as well as any custom options for that notification method.

Email

Send email notifications with all current event information to users who have subscribed to dashboard email updates.

SMS

Send SMS notifications with a link to the dashboard event page to users who have subscribed to dashboard SMS updates.

Twitter

Post a tweet to a configured Twitter timeline with custom text and a link to the dashboard event page.

HipChat

Post a message to one or more HipChat rooms with a custom message and a link to the dashboard event page.

Slack

Post a message to one or more Slack channels with a custom message and a link to the dashboard event page.

Webhooks

Send programmatic messages to subscribed http/https endpoints with a JSON payload containing all current information about the event.


Updating Events

To update an existing event, navigate to Events and select either Incident List or Maintenance List.  You may modify the event by selecting the edit icon next to the event in the search results.  From the event update screen, you may enter an event update (for example, provide a status update on resolution), modify/delete previous updates, or modify any of the existing event parameters.  From the event update screen, you may also broadcast an update to your subscribed customers.

Scheduled Maintenance Templates

Scheduled maintenance templates can be used as a starting point when creating scheduled maintenance events. If you frequently schedule maintenance events where you use the same settings and language, you can create templates to greatly simplify future event creation.  Once a maintenance template has been created, the only values that you need to enter in order to create a maintenance event are the start/end date and time.


Required Permissions Role: Administrator or Events