Describes the webhook payload schema and an illustrative sample for a specific event type.

GET /api/notifications/event-types/{eventType}/payload-schema deprecated

Requires: Notifications.EventTypes, merchant scope.

**Required permissions**: `Notifications.EventTypes` **Scope**: merchant

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/notifications/event-types/{eventType}/payload-schema" \
  -H "api-key: {{API_KEY}}"

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/notifications/event-types/{eventType}/payload-schema' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, NotificationsApi } from '@winkpg/winkpg-api';

const api = new NotificationsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.notificationsGetPayloadSchema("EVENT_TYPE");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/notifications/event-types/{eventType}/payload-schema', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new NotificationsApi(config);
var result = await api.NotificationsGetPayloadSchemaAsync("EVENT_TYPE");

C# (raw HTTP)

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/notifications/event-types/{eventType}/payload-schema");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.NotificationsApi(client)
    result = api.notifications_get_payload_schema("EVENT_TYPE")

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/notifications/event-types/{eventType}/payload-schema",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`eventType` required	path	string
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.

Responses

200 OK

Body: WebhookPayloadSchemaDto Each item has these fields.

Field	Type	Description
`eventType` required	string	The canonical event type string this schema describes. nullable
`hasRichPayload` required	boolean	True when the event delivers a structured `data` object (an aggregate-backed event such as a transaction completion). False for events that deliver only the flat `attributes` map: for those, `dataFields` is empty and the sample shows the flat shape.
`dataFields` required	array of WebhookPayloadSchemaField	The schema of the `data` object's fields, generated from the payload CLR type via the same exclusion logic the runtime projector uses. Empty when `hasRichPayload` is false. nullable
`sampleEnvelopeJson` required	string	A pretty-printed, illustrative sample of the full webhook envelope (id, type, version, createdUtc, scope ids, correlationId, data) with placeholder values. For display only: the values are synthetic, the shape is real. nullable

This response has no documented body fields.

default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

This response has no documented body fields.

429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Notifications

The API reference isn't available right now

No such operation

This reference may be out of date

Describes the webhook payload schema and an illustrative sample for a specific event type.

Example request

Parameters

Request body

Responses

200 OK

Errors

Authentication