Subscriptions allow users to be notified about events even if they were not initially targeted by the notification message sent by a communication plan. For example, a restaurant manager could subscribe to all equipment failure alerts, even though these alerts may only be sent to the on-duty repair personnel assigned to handle them.
To allow people to subscribe to events, you must create a subscription form for each communication plan that you want to have subscriptions. Subscription forms define who can subscribe to events, which properties they can subscribe to, and whether they can respond to notifications. You can also use these forms to set message content for the notifications sent to subscribers, and how to handle any responses.
You can create a subscription form that will trigger a subscription for all events related to a communication plan, or just for events related to a single form within a plan.
Once you have designed and configured a subscription form, you can create event feeds based on the form that define which properties and values should trigger a notification, and which devices should receive the message. Users can then subscribe to the events that most relate to them, or their supervisors can assign subscriptions on their behalf.
- On the Developer tab, on the Manage Communication Plans page, choose a communication plan you want to subscribe to, and then click Edit >
- To create a new subscription form, click Create Subscription Form, and then enter the following information in the Create New Subscription Form dialog box):
- Name: Type a name for the new subscription form. The new form cannot have the same name as any other subscription form within the company, including ones created by other users.
- Description: Type a brief description of the form that can help you and other users identify it. (Optional)
- Scope: In the drop-down list select All Forms to allow subscriptions based on the communication plan, or select the name of a form to allow subscriptions based only on that form
- In the Design Subscription Form window, configure the details of the form, as described in the following table:
When selected, all subscriptions based on this form will be read-only (no responses configured or required). Clear this check box if you want notifications to include response options.
Note: For more information about how response options and their assigned actions behave for subscriptions, see How subscription responses work.
When selected, event feeds based on this form will include the Subscribers section, which allows creators to add other users, devices, groups, and dynamic teams to the event feed as subscribers. If this option is not selected, the Subscribers section is hidden, and users must subscribe themselves.
Defines the number of minutes that xMatters waits before sending the notification. The notification is not delivered if the event is terminated before this time has elapsed.
You can use this feature to be notified about only those events that run longer than expected or are not resolved within a required time frame. You will not receive any subscription notifications about events that are resolved quickly.
For example, if you have a service-level agreement that all issues for a particular customer will be addressed within two hours, you could set the Notification Delay to 90 minutes. xMatters will then automatically send you a subscription notification whenever an issue is open or unsolved long enough to come close to violating your SLA.
This row displays the universally unique identifier (UUID) that you can use to target this specific subscription form when using the xMatters API. For more information, see Locate identifiers for forms, properties, and other elements in xMatters.
This area identifies which properties will be available to users when creating subscriptions based on this subscription form. To allow users to base a subscription on a property, drag it from the Form Properties list on the right and drop it in this area.
If you are creating a subscription form based on a specific communication plan form, you can only add properties that are already included on the communication plan form's Layout tab.
Subscription notifications may still include other properties from the original event or form; this section only limits the properties that subscriptions can be based on.
|Roles that can subscribe||
Use the search bar to locate and add the roles you want to be able to create event feeds based on this form.
You can use this section to specify which devices will be able to receive notifications based on the event feeds using this form. For example, you may want to limit subscription notifications for all related event feeds to be email-only. Or you may want to make sure that notifications are not delivered to a user's home phone.
If users do not have a device with one of the specified names, they will not be able to receive notifications from event feeds based on this form.
- Click Save Changes.
You can now create subscriptions based on this subscription form.
To make changes to an existing subscription form, click its name in the list, and then modify its details on the Subscription Form Details page. (See the section above for more information about the available details.)
To remove a subscription form, click the red X beside its name in the list.
You can only remove a subscriptions form if it does not have any associated subscriptions already created for it.