API reference
WinkPG API version v1. 683 endpoints published by this instance.
The API reference isn't available right now
This instance couldn't load its API specification, so this page lists nothing. The reference returns as soon as the specification is readable again.
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
75 endpoints are in reach of the webhooks scope. Scopes only restrict a key, so the account that owns it still needs the permissions each endpoint lists.
This instance publishes no API operations.
No endpoint this instance publishes is in reach of that scope. Choose All scopes to see the whole reference.
Platform Configuration
Contract Revision
The API contract revision this instance serves, so a client built against a newer contract can tell an older instance from a missing feature.
Messaging & Notifications
Notifications
Notification channels, destinations, subscriptions, and delivery tracking.
- GET
/api/notifications/channelsdeprecated webhooks Get a list of NotificationChannels Requires: Notifications.Channels, merchant scope. - POST
/api/notifications/channelsdeprecated webhooks Create a NotificationChannel Requires: Notifications.Channels, Notifications.Channels.Create, merchant scope. - POST
/api/notifications/channels/list/continuationdeprecated webhooks Retrieves a continuation-based page of NotificationChannels. Requires: Notifications.Channels, merchant scope. - POST
/api/notifications/channels/list/continuation/countdeprecated webhooks Counts the NotificationChannels that match a filter. Requires: Notifications.Channels, merchant scope. - POST
/api/notifications/channels/list/continuation/summary-countsdeprecated webhooks Counts NotificationChannels for several filters at once. Requires: Notifications.Channels, merchant scope. - DELETE
/api/notifications/channels/{id}deprecated webhooks Delete a NotificationChannel Requires: Notifications.Channels, Notifications.Channels.Delete, merchant scope. - GET
/api/notifications/channels/{id}deprecated webhooks Get a NotificationChannel Requires: Notifications.Channels, merchant scope. - PUT
/api/notifications/channels/{id}deprecated webhooks Update a NotificationChannel Requires: Notifications.Channels, Notifications.Channels.Update, merchant scope. - GET
/api/notifications/channels/{id}/accessdeprecated webhooks Check NotificationChannel access Requires: Notifications.Channels, merchant scope. - POST
/api/notifications/channels/{id}/disabledeprecated webhooks Disables a channel. Requires: Notifications.Channels, Notifications.Channels.Update, merchant scope. - POST
/api/notifications/channels/{id}/duplicatedeprecated webhooks Duplicates a channel. Requires: Notifications.Channels, Notifications.Channels.Create, merchant scope. - POST
/api/notifications/channels/{id}/enabledeprecated webhooks Enables a channel. Requires: Notifications.Channels, Notifications.Channels.Update, merchant scope. - GET
/api/notifications/channels/{id}/namedeprecated webhooks Get a NotificationChannel name by id Requires: Notifications.Channels, merchant scope. - POST
/api/notifications/channels/{id}/restoredeprecated webhooks Restore a deleted NotificationChannel Requires: Notifications.Channels, merchant scope. - POST
/api/notifications/deliveries/outcome-summarydeprecated webhooks Counts how deliveries ended in a time window, broken down by outcome. Requires: Notifications.Deliveries, merchant scope. - GET
/api/notifications/destinationsdeprecated webhooks Get a list of NotificationDestinations Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinationsdeprecated webhooks Create a NotificationDestination Requires: Notifications.Destinations, Notifications.Destinations.Create, merchant scope. - POST
/api/notifications/destinations/list/continuationdeprecated webhooks Retrieves a continuation-based page of NotificationDestinations. Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/list/continuation/countdeprecated webhooks Counts the NotificationDestinations that match a filter. Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/list/continuation/summary-countsdeprecated webhooks Counts NotificationDestinations for several filters at once. Requires: Notifications.Destinations, merchant scope. - GET
/api/notifications/destinations/types/metadatadeprecated webhooks Returns metadata (icon, logo) for all supported destination types. Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/types/{type}/test-configdeprecated webhooks Tests a destination configuration without requiring a saved entity. Requires: Notifications.Destinations, Notifications.Destinations.Create, merchant scope. - POST
/api/notifications/destinations/types/{type}/validatedeprecated webhooks Validates destination configuration for a specific type. Requires: Notifications.Destinations, merchant scope. - DELETE
/api/notifications/destinations/{id}deprecated webhooks Delete a NotificationDestination Requires: Notifications.Destinations, Notifications.Destinations.Delete, merchant scope. - GET
/api/notifications/destinations/{id}deprecated webhooks Get a NotificationDestination Requires: Notifications.Destinations, merchant scope. - PUT
/api/notifications/destinations/{id}deprecated webhooks Update a NotificationDestination Requires: Notifications.Destinations, Notifications.Destinations.Update, merchant scope. - GET
/api/notifications/destinations/{id}/accessdeprecated webhooks Check NotificationDestination access Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/{id}/disabledeprecated webhooks Disables a destination. Requires: Notifications.Destinations, Notifications.Destinations.Update, merchant scope. - POST
/api/notifications/destinations/{id}/duplicatedeprecated webhooks Duplicates a destination. Requires: Notifications.Destinations, Notifications.Destinations.Create, merchant scope. - POST
/api/notifications/destinations/{id}/enabledeprecated webhooks Enables a destination. Requires: Notifications.Destinations, Notifications.Destinations.Update, merchant scope. - GET
/api/notifications/destinations/{id}/namedeprecated webhooks Get a NotificationDestination name by id Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/{id}/restoredeprecated webhooks Restore a deleted NotificationDestination Requires: Notifications.Destinations, merchant scope. - GET
/api/notifications/destinations/{id}/secret-rotationdeprecated webhooks Gets a destination's signing-secret rotation state. Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/{id}/secret-rotation/begindeprecated webhooks Starts a signing-secret rotation. Requires: Notifications.Destinations, Notifications.Destinations.Update, merchant scope. - POST
/api/notifications/destinations/{id}/secret-rotation/canceldeprecated webhooks Abandons a signing-secret rotation. Requires: Notifications.Destinations, Notifications.Destinations.Update, merchant scope. - POST
/api/notifications/destinations/{id}/secret-rotation/promotedeprecated webhooks Completes a signing-secret rotation. Requires: Notifications.Destinations, Notifications.Destinations.Update, merchant scope. - POST
/api/notifications/destinations/{id}/send-sampledeprecated webhooks Sends a realistic sample of one event type to a saved webhook destination. Requires: Notifications.Destinations, Notifications.Destinations.Test, merchant scope. - GET
/api/notifications/destinations/{id}/suppressiondeprecated webhooks Gets the durable suppression state for a destination's endpoint. Requires: Notifications.Destinations, merchant scope. - POST
/api/notifications/destinations/{id}/suppression/cleardeprecated webhooks Clears the suppression on a destination's endpoint so delivery resumes on the next event. Requires: Notifications.Destinations, Notifications.Suppressions.Clear, merchant scope. - POST
/api/notifications/destinations/{id}/testdeprecated webhooks Tests a saved destination by sending a test notification. Requires: Notifications.Destinations, Notifications.Destinations.Test, merchant scope. - GET
/api/notifications/event-typesdeprecated webhooks Returns all event types available for the current user's scope. Requires: Notifications.EventTypes, merchant scope. - GET
/api/notifications/event-types/{eventType}/payload-schemadeprecated webhooks Describes the webhook payload schema and an illustrative sample for a specific event type. Requires: Notifications.EventTypes, merchant scope. - GET
/api/notifications/event-types/{eventType}/sample-payloaddeprecated webhooks Returns a sample payload for a specific event type. Requires: Notifications.EventTypes, merchant scope. - GET
/api/notifications/eventsdeprecated webhooks Lists the webhooks sent to your endpoints in a time window. Requires: Notifications.Events, merchant scope. - POST
/api/notifications/events/replaydeprecated webhooks Sends every replayable delivery in a time window to your endpoints again. Requires: Notifications.Events.Replay, merchant scope. - GET
/api/notifications/events/{id}deprecated webhooks Reads one webhook delivery, including the body posted to your endpoint. Requires: Notifications.Events, merchant scope. - POST
/api/notifications/events/{id}/replaydeprecated webhooks Sends one webhook delivery to your endpoint again. Requires: Notifications.Events.Replay, merchant scope. - POST
/api/notifications/filters/validatedeprecated webhooks Validates a filter expression. Requires: Notifications.Subscriptions, merchant scope. - GET
/api/notifications/inboxdeprecated webhooks Lists the caller's notifications, newest first. No permission required. - GET
/api/notifications/inbox/categoriesdeprecated webhooks Lists the notification categories the inbox can be filtered by. No permission required. - POST
/api/notifications/inbox/mark-all-readdeprecated webhooks Marks the caller's unread notifications read. No permission required. - GET
/api/notifications/inbox/unread-summarydeprecated webhooks Counts the caller's unread notifications. No permission required. - POST
/api/notifications/inbox/{id}/mark-readdeprecated webhooks Marks one of the caller's notifications read. No permission required. - POST
/api/notifications/listen-sessionsdeprecated webhooks Opens a listen session for the caller's merchant and returns its signing secret, once. Requires: Notifications.ListenSessions.Listen, merchant scope. - POST
/api/notifications/listen-sessions/{id}/enddeprecated webhooks Ends the caller's own session. Its cursor and its secret stop working. Requires: Notifications.ListenSessions.Listen, merchant scope. - GET
/api/notifications/listen-sessions/{id}/eventsdeprecated webhooks Returns events staged after the cursor, oldest first, and renews the session. Requires: Notifications.ListenSessions.Listen, merchant scope. - POST
/api/notifications/listen-sessions/{id}/sampledeprecated webhooks Stages the event catalog's sample for one event type into a live session's buffer. Requires: Notifications.ListenSessions.Listen, Notifications.Destinations.Test, merchant scope. - GET
/api/notifications/subscriptionsdeprecated webhooks Get a list of NotificationSubscriptions Requires: Notifications.Subscriptions, merchant scope. - POST
/api/notifications/subscriptionsdeprecated webhooks Create a NotificationSubscription Requires: Notifications.Subscriptions, Notifications.Subscriptions.Create, merchant scope. - POST
/api/notifications/subscriptions/list/continuationdeprecated webhooks Retrieves a continuation-based page of NotificationSubscriptions. Requires: Notifications.Subscriptions, merchant scope. - POST
/api/notifications/subscriptions/list/continuation/countdeprecated webhooks Counts the NotificationSubscriptions that match a filter. Requires: Notifications.Subscriptions, merchant scope. - POST
/api/notifications/subscriptions/list/continuation/summary-countsdeprecated webhooks Counts NotificationSubscriptions for several filters at once. Requires: Notifications.Subscriptions, merchant scope. - DELETE
/api/notifications/subscriptions/{id}deprecated webhooks Delete a NotificationSubscription Requires: Notifications.Subscriptions, Notifications.Subscriptions.Delete, merchant scope. - GET
/api/notifications/subscriptions/{id}deprecated webhooks Get a NotificationSubscription Requires: Notifications.Subscriptions, merchant scope. - PUT
/api/notifications/subscriptions/{id}deprecated webhooks Update a NotificationSubscription Requires: Notifications.Subscriptions, Notifications.Subscriptions.Update, merchant scope. - GET
/api/notifications/subscriptions/{id}/accessdeprecated webhooks Check NotificationSubscription access Requires: Notifications.Subscriptions, merchant scope. - POST
/api/notifications/subscriptions/{id}/disabledeprecated webhooks Disables a subscription. Requires: Notifications.Subscriptions, Notifications.Subscriptions.Update, merchant scope. - POST
/api/notifications/subscriptions/{id}/duplicatedeprecated webhooks Duplicates a subscription. Requires: Notifications.Subscriptions, Notifications.Subscriptions.Create, merchant scope. - POST
/api/notifications/subscriptions/{id}/enabledeprecated webhooks Enables a subscription. Requires: Notifications.Subscriptions, Notifications.Subscriptions.Update, merchant scope. - GET
/api/notifications/subscriptions/{id}/namedeprecated webhooks Get a NotificationSubscription name by id Requires: Notifications.Subscriptions, merchant scope. - POST
/api/notifications/subscriptions/{id}/restoredeprecated webhooks Restore a deleted NotificationSubscription Requires: Notifications.Subscriptions, merchant scope. - GET
/api/notifications/unsubscribedeprecated webhooks Handles unsubscribe link clicks from emails. No permission required. - POST
/api/notifications/unsubscribedeprecated webhooks Handles RFC 8058 one-click unsubscribe (POST with List-Unsubscribe-Post header). No permission required. - POST
/api/notifications/unsubscribe/confirmdeprecated webhooks Confirms the unsubscribe request and disables the subscription. No permission required.