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

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

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

**Operation ID:** `GET_api_notifications_event-types_eventType_payload-schema`

## Authorization

Requires: Notifications.EventTypes, merchant scope.

Required permissions:
- `Notifications.EventTypes`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| eventType | path | yes | string |  |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `text/plain`

Schema: `WinkPGNotificationsWebhookPayloadSchemaDto`

**Content type:** `application/json`

Schema: `WinkPGNotificationsWebhookPayloadSchemaDto`

**Content type:** `text/json`

Schema: `WinkPGNotificationsWebhookPayloadSchemaDto`

### 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.

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

- [All documentation](https://docs.winkpg.io/llms.txt): the machine-readable index of every public page on this site.