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

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.

Responses

200 OK

OK

Body: WebhookPayloadSchemaDto WebhookPayloadSchemaDto Each item has these fields.

Field Type Description

eventType required

string

The canonical event type string this schema describes. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

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.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

dataFields required

array of WebhookPayloadSchemaField 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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each WebhookPayloadSchemaField:

Field Type Description

name required

string

The JSON field name (the CLR property name, emitted verbatim by the projector). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

type required

string

The JSON type the value serializes as. One of the values in `WebhookPayloadSchemaTypes`: `string`, `integer`, `number`, `boolean`, `datetime`, `object`, or `array`. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

nullable required

boolean

Whether the field can be `null` / absent. Reference types and `Nullable` value types are nullable; non-nullable value types are not. This is a best-effort hint derived from the CLR type, not a guarantee that the field is always populated.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

A curated, integrator-facing note about this field, or `null` when its name and type say enough. Sourced from `WebhookPayloadFieldDescriptions` by the field's dotted path, so the catalog and the delivered payload still come from one traversal. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

fields required

array of WebhookPayloadSchemaField array of WebhookPayloadSchemaField

For `type` == `object`: the nested fields of the object. Null for scalar fields. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

items required

WebhookPayloadSchemaField WebhookPayloadSchemaField

For `type` == `array`: a descriptor for the array's element. The element descriptor's `name` is empty. Null for non-array fields.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

truncated required

boolean

True when the describe walk stopped at this node because the recursion-depth ceiling or a type cycle was hit. The actual delivered payload carries a `__truncated` marker in the same place. Defensive guard: not expected on today's tree-shaped aggregates.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

429 Too Many Requests

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 RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors default

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. The error reference lists the values `error.code` can take.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. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of RemoteServiceErrorInfo:

Field Type Description

code required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

message required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

details required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

data required

object

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

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

Authentication

ApiKey with scopes

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

Errors

Authentication