The OnPage 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
Fill the form to request for the document:
WHAT ARE THE BENEFITS OF THIS API UPDATE? WHY SHOULD I SWITCH?
OnPage REST API v2 allows:
- 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
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 registered message_status 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 callbackUri 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 [email protected]. 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.