Monitoring the health of an xMatters environment

Question 

We want to use our monitoring tools to send an alert if xMatters is having an issue. What endpoints can we use to see if the environment is up or not?

Environment

All versions of xMatters

Answer

The best option is to use the login page as your endpoint:

https://<myCompany>.xmatters.com

If you're using SAML, you can use the SSO bypass page:

https://<myCompany>.xmatters.com/sp/samlSignOn.do

To check your non-production instances, use:

https://<myCompany>-np.xmatters.com
https://<myCompany>-np.xmatters.com/sp/samlSignOn.do

If you are using an Integration Agent, the heartbeat from the agent will tell you if the system is down as well. The sign on page will let you know if the system is up, or you could use the same endpoint that the Integration Agent uses.

Note: We don't officially support the ping URL in the current product so it's best to stick to the above recommended methods.