Highnote Webhooks & Event Notifications API
Register HTTPS webhook notification targets (addWebhookNotificationTarget), activate and deactivate them, and subscribe to event types (addSubscriptionsToNotificationTarget) so Highnote pushes account, card, transaction, transfer, and application events to your systems in real time rather than requiring you to poll the API. Delivered events are also queryable via notificationEvents. All configuration runs through the single GraphQL endpoint; delivery is outbound HTTPS POST to your registered target.
Highnote Webhooks & Event Notifications API is one of 7 APIs that Highnote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Webhooks, Event Notifications, Events, Subscriptions, and Real-time. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against 2 base URLs: https://api.us.highnote.com, https://api.us.test.highnote.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Highnote Webhooks & Event Notifications API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
basicAuth— HTTP Basic auth. The base64-encoded API key is supplied as the username and the password is left empty. Equivalent to sending Authorization: Basic .
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Single GraphQL endpoint for all Highnote operations.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are GraphQLError (3 properties), GraphQLRequest (3 properties), GraphQLResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Highnote 6
Other APIs Highnote publishes across the network.