Opens a listen session for the caller's merchant and returns its signing secret, once.

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 CreateListenSessionInput. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/notifications/listen-sessions" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "eventTypes": [
    ""
  ]
}'

PowerShell

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

$body = @'
{
  "eventTypes": [
    ""
  ]
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/notifications/listen-sessions' `
    -Headers $headers -ContentType 'application/json' -Body $body

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.notificationsCreateListenSessions({
  "eventTypes": [
    ""
  ]
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/notifications/listen-sessions', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "eventTypes": [
      ""
    ]
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

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

var api = new NotificationsApi(config);
var body = JsonSerializer.Deserialize<CreateListenSessionInput>("""
    {
      "eventTypes": [
        ""
      ]
    }
    """);

var result = await api.NotificationsCreateListenSessionsAsync(body);

C# (raw HTTP)

using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/notifications/listen-sessions");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "eventTypes": [
        ""
      ]
    }
    """, Encoding.UTF8, "application/json");

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)
    body = winkpg_api.CreateListenSessionInput.from_dict({
      "eventTypes": [
        ""
      ]
    })
    result = api.notifications_create_listen_sessions(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "eventTypes": [
    ""
  ]
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/notifications/listen-sessions",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

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

Request body

application/json , required

Field	Type	Description
`eventTypes` required	array of string	Event types to stage. Empty means every event type the caller may see, resolved once at creation and then fixed for the session's lifetime. nullable
`label` required	string	Optional human label, so an operator's list reads sensibly. nullablemax length 128
`ttlMinutes` required	integer (int32)	Requested session lifetime in minutes, renewed by poll activity. Clamped server-side; a value outside the supported range is corrected, not refused. nullable

This request body has no documented fields.

Responses

200 The session was opened. The body carries the signing secret, once.

Body: ListenSessionCreatedDto Each item has these fields.

Field	Type	Description
`id` required	string (uuid)	The session id, used on the poll, sample and end routes.
`signingSecret` required	string	The signing secret, shown exactly once. nullable
`merchantId` required	string (uuid)	The merchant the session is scoped to.
`eventTypes` required	array of string	The resolved event types the session stages. nullable
`expiresAtUtc` required	string (date-time)	When the session expires unless polling renews it.
`ttlMinutes` required	integer (int32)	The clamped session lifetime, in minutes, that each poll renews by.

This response has no documented body fields.

403 The caller has no merchant context, so there is no single merchant to scope a session to.

Body: Each item has these fields.

Field	Type	Description

This response has no body.

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

Body: RateLimitProblemDetails Each item has these fields.

Field	Type	Description
`type` required	string	The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. nullable
`title` required	string	A short, human-readable summary of the problem type. nullable
`status` required	integer (int32)	The HTTP status code, repeated in the body as the problem-details format defines.
`detail` required	string	A human-readable explanation of this occurrence of the problem. nullable
`retryAfterSeconds` required	integer (int32)	How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again.

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

Opens a listen session for the caller's merchant and returns its signing secret, once.

Example request

Parameters

Request body

Responses

200 The session was opened. The body carries the signing secret, once.

403 The caller has no merchant context, so there is no single merchant to scope a session to.

429 The request was refused because a rate limit was exceeded. 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.

Errors

Authentication