The OnPage API v2

WHAT’S IN API V2?

The OnPage API v2 will enable developers and OnPage users to extend The OnPage Incident Alert Management Platform with ease. The new API v2 release supports:

  • Message status callbacks
  • Account status callbacks: PAGER_OFF, LOGGED_IN and LOGGED_OUT
  • Information on whether the account is logged in

WHEN IS API V2 AVAILABLE?

The OnPage API v2 will be available upon request as off 07/18/2017. Go here to create a request for the API v2 Document

OnPage REST API v2 allows you to:

  • Send OnPage Messages to individuals and groups
  • Send OnPage Messages in different priorities: High or Low priority
  • Send OnPage Messages with attachments
  • Receive message audit trails via callbacks
  • Receive OPID audit trails via callbacks

WHAT’s NEW IN THE API UPDATE? WHY SHOULD I SWITCH?

The OnPage API v2 enhancements to Callbacks

OnPage REST API v2 allows the registration of message status and OPID status callbacks. REST API token received in authentication response must have REGISTER_CALLBACK permission to register callbacks.

The OnPage API v2 enhancements to Message Status Updates

OnPage will call the callback URL using POST for sending message status updates. Status values are as follows:

  • “PENDING”
  • “SENT”
  • “DELIVERED”
  • “READ”
  • “REPLIED”
  • “FAILED”
  • “PAGER OFF”

The OnPage API v2 enhancements to OPID Status Updates

OnPage will call registered account status callback URL using POST for sending account status updates (logged in/off, pager on/off).
Status updates for sent messages can be obtained in callbacks to the URL address specified in the callback/ url field of the Send Message request. The callback service has to process both GET and POST requests on the same URL address.

WHAT SUPPORT CAN I EXPECT FROM ONPAGE IN MAKING THE SWITCH?

Customers can expect full support for requests related to switching to the new API v2 — please direct all inquiries to support@onpagecorp.com. We have created a detailed API document that will guide you through the change. We look forward to partnering with you to help you explore The OnPage API V2.

WHO DO I CONTACT FOR MORE INFORMATION?

Please contact our support team at support@onpagecorp.com if you have any questions.

Shawn Lazarus

Share
Published by
Shawn Lazarus

Recent Posts

Top Kubernetes Monitoring Tools in 2025, And Why Alerting Is Critical for DevOps and SRE Teams

What are the best Kubernetes monitoring tools in 2025? And how can you ensure alerts…

4 days ago

Best Website Monitoring Systems of 2025

If you still think websites are a “set it and forget it” asset, your business…

5 days ago

Top 7 Error Tracking Solutions 2025

You can write clean code, test obsessively, and deploy with crossed fingers…but errors always find…

2 weeks ago

Advancements in Digital Care Delivery: OnPage’s Perspective Inspired by the 2025 Gartner® Hype Cycle™

Each year, Gartner’s Hype Cycle provides a powerful lens through which to view the evolving…

2 weeks ago

5 Best Building Automation Systems of 2025

Managing a facility means dealing with issues at all hours, often when no one is…

2 weeks ago

10 Best Ticketing Tools of 2025

Whether you’re dealing with IT issues, customer questions, or just trying to keep track of…

2 weeks ago