Home / Basics / Highnote API

API Status and Changes

API and Platform Status

Highnote provides transparency on the operational status of the Platform and GraphQL using the Highnote Status Page. You can subscribe to updates on the page and will be notified of any downtime.

When an incident impacting the platform and GraphQL API occurs, the Highnote team immediately begins their investigation, assesses the impact and communicates via the status page. Below provides details of each of the phases and activities that occur in each phase.

PhaseActivities
Incident IdentificationWhen an incident has been identified, Highnote will create an incident in the incident tracking system and begin the investigation.
Investigation & CommunicationThe Highnote Incident Commander and incident response team work to investigate the issue, determine scope, and identify resolution. Based on the scope and severity, the Highnote status page is updated with partial or full outage.
Resolution & CommunicationOnce the resolution is identified and tested, the fix is deployed to production. The Highnote team will then communicate update(s) to you through the Highnote status page.
Post MortemAfter the incident management process has occurred, the Highnote incident response team walks through what happened, the resolution and lessons learned for future improvements.

API and Platform Changes

To maintain uninterrupted service, we recommend building robust and resilient integrations that can adapt to API and platform changes.

When changes occur on the Highnote Platform and GraphQL API, the Highnote team reviews all changes to assess the impact and provides proactive communication to you about the upcoming changes. The following table provides details of each phase for implementing platform changes and activities that occur in each phase.

PhaseActivities
PlanningOnce a change is determined, change planning begins. This includes creating documentation of the change and impact.
Communication and DocumentationThe Highnote team ensures documentation of the change is completed and your usage is reviewed to determine impact to you. Highnote creates communication that includes the description of the change, reason for the change, potential impact to you of the change and timing. For more information on communication timelines, see Additive Changes and Breaking Changes.
ImplementationHighnote ensures the execution of communication to you by Highnote Customer Support. This includes performing the change as documented.
RetrospectiveAfter the change is launched, Highnote holds a retrospective to reflect on the change management process.

Additive Changes

Additive changes refer to modifications to notifications and/or Highnote’s API schema that introduces new features, functionality, or resources without altering or removing existing components.

Highnote provides seven days notice before releasing additive changes.

Breaking Changes

Breaking changes refer to modifications to notifications and/or Highnote’s API schema that alters existing behavior in a way that may cause existing client applications and integrations to break or malfunction.

Highnote provides 90 days notice before releasing breaking changes.

Provide Feedback

Was this content helpful?