# POST /api/notifications/destinations

Create a NotificationDestination

Create a new NotificationDestination

**Operation ID:** `notificationsCreateDestinations`

## Authorization

Requires: Notifications.Destinations, Notifications.Destinations.Create, merchant scope.

Requires API key scope: `webhooks`

Required permissions:
- `Notifications.Destinations`
- `Notifications.Destinations.Create`

## Parameters

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

## Request Body

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

Schema: [`NotificationDestinationCreateDto`](https://devportal.demo.winkpg.io/docs/api/models/NotificationDestinationCreateDto.md)

Properties:
- `name` (string) required: Destination name. (min length 1, max length 256)
- `description` (string): Optional description. (nullable, min length 0, max length 1024)
- `type` ([DestinationType](https://devportal.demo.winkpg.io/docs/api/models/DestinationType.md)) required: The delivery transport type.
  Values:
  - `Webhook`: HTTP POST to a configured URL with HMAC signature headers.
  - `Email`: Email delivery to the configured recipient addresses.
  - `AmazonSqs`: Amazon Simple Queue Service (SQS) message delivery.
  - `AzureServiceBusQueue`: Azure Service Bus Queue message delivery.
  - `InApp`: In-app notification delivered in-process to connected clients on this instance. Suitable for real-time UI notifications (dropdown, popup, badge).
  - `Slack`: Slack message delivery via Block Kit-formatted channel messages. Supports per-destination bot tokens for multi-workspace routing.
  - `Sms`: SMS text message delivery to a single recipient phone number via the platform SMS sender. Opt-out compliance is enforced at send time, so an opted-out recipient is blocked before the carrier is contacted.
- `configJson` (string) required: Type-specific configuration JSON. (min length 1, max length 4096)
- `isEnabled` (boolean): Whether the destination is enabled.

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

Schema: [`NotificationDestinationCreateDto`](https://devportal.demo.winkpg.io/docs/api/models/NotificationDestinationCreateDto.md)

Properties:
- `name` (string) required: Destination name. (min length 1, max length 256)
- `description` (string): Optional description. (nullable, min length 0, max length 1024)
- `type` ([DestinationType](https://devportal.demo.winkpg.io/docs/api/models/DestinationType.md)) required: The delivery transport type.
  Values:
  - `Webhook`: HTTP POST to a configured URL with HMAC signature headers.
  - `Email`: Email delivery to the configured recipient addresses.
  - `AmazonSqs`: Amazon Simple Queue Service (SQS) message delivery.
  - `AzureServiceBusQueue`: Azure Service Bus Queue message delivery.
  - `InApp`: In-app notification delivered in-process to connected clients on this instance. Suitable for real-time UI notifications (dropdown, popup, badge).
  - `Slack`: Slack message delivery via Block Kit-formatted channel messages. Supports per-destination bot tokens for multi-workspace routing.
  - `Sms`: SMS text message delivery to a single recipient phone number via the platform SMS sender. Opt-out compliance is enforced at send time, so an opted-out recipient is blocked before the carrier is contacted.
- `configJson` (string) required: Type-specific configuration JSON. (min length 1, max length 4096)
- `isEnabled` (boolean): Whether the destination is enabled.

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

Schema: [`NotificationDestinationCreateDto`](https://devportal.demo.winkpg.io/docs/api/models/NotificationDestinationCreateDto.md)

Properties:
- `name` (string) required: Destination name. (min length 1, max length 256)
- `description` (string): Optional description. (nullable, min length 0, max length 1024)
- `type` ([DestinationType](https://devportal.demo.winkpg.io/docs/api/models/DestinationType.md)) required: The delivery transport type.
  Values:
  - `Webhook`: HTTP POST to a configured URL with HMAC signature headers.
  - `Email`: Email delivery to the configured recipient addresses.
  - `AmazonSqs`: Amazon Simple Queue Service (SQS) message delivery.
  - `AzureServiceBusQueue`: Azure Service Bus Queue message delivery.
  - `InApp`: In-app notification delivered in-process to connected clients on this instance. Suitable for real-time UI notifications (dropdown, popup, badge).
  - `Slack`: Slack message delivery via Block Kit-formatted channel messages. Supports per-destination bot tokens for multi-workspace routing.
  - `Sms`: SMS text message delivery to a single recipient phone number via the platform SMS sender. Opt-out compliance is enforced at send time, so an opted-out recipient is blocked before the carrier is contacted.
- `configJson` (string) required: Type-specific configuration JSON. (min length 1, max length 4096)
- `isEnabled` (boolean): Whether the destination is enabled.

## Responses

### 200

OK

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

Schema: [`NotificationDestinationDto`](https://devportal.demo.winkpg.io/docs/api/models/NotificationDestinationDto.md)

Properties:
- `extraProperties` (object): (nullable, read only)
- `id` (string(uuid))
- `creationTime` (string(date-time)): The date and time when this entity was created.
- `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
- `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
- `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
- `isDeleted` (boolean): Indicates whether this entity has been deleted.
- `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
- `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
- `name` (string): Destination name. (nullable)
- `description` (string): Optional description. (nullable)
- `type` ([DestinationType](https://devportal.demo.winkpg.io/docs/api/models/DestinationType.md)): The delivery transport type.
  Values:
  - `Webhook`: HTTP POST to a configured URL with HMAC signature headers.
  - `Email`: Email delivery to the configured recipient addresses.
  - `AmazonSqs`: Amazon Simple Queue Service (SQS) message delivery.
  - `AzureServiceBusQueue`: Azure Service Bus Queue message delivery.
  - `InApp`: In-app notification delivered in-process to connected clients on this instance. Suitable for real-time UI notifications (dropdown, popup, badge).
  - `Slack`: Slack message delivery via Block Kit-formatted channel messages. Supports per-destination bot tokens for multi-workspace routing.
  - `Sms`: SMS text message delivery to a single recipient phone number via the platform SMS sender. Opt-out compliance is enforced at send time, so an opted-out recipient is blocked before the carrier is contacted.
- `configJson` (string): Type-specific configuration JSON. (nullable)
- `status` ([DestinationStatus](https://devportal.demo.winkpg.io/docs/api/models/DestinationStatus.md)): Current health status.
  Values:
  - `Default`: Destination has not been tested or is operating normally.
  - `ConfigurationError`: Destination configuration is invalid (e.g., malformed URL, missing credentials).
  - `ThrottlingWarning`: Destination is responding but rate-limiting or throttling requests.
  - `ExternalServerError`: External server returned 5xx errors.
  - `TimeoutError`: Delivery timed out waiting for response.
  - `AuthError`: Authentication or authorization failure (401/403).
  - `UnknownError`: An unclassified error occurred during delivery.
- `lastErrorDetail` (string): Detail from the last error, if any. (nullable)
- `lastTestedAtUtc` (string(date-time)): UTC timestamp of the last test or health check. (nullable)
- `isEnabled` (boolean): Whether the destination is enabled.
- `scope` ([EntityScopeKind](https://devportal.demo.winkpg.io/docs/api/models/EntityScopeKind.md)): Ownership scope of this destination: merchant, reseller, or tenant-wide (admin-owned).  Stamped server-side at creation from the creating caller's operating context and never  settable through the create or update DTO. (nullable)
  Values:
  - `Merchant`: Row applies to a single merchant. MerchantId must be non-null.
  - `Reseller`: Row applies to a reseller and (by entity-specific semantics) its descendants. ResellerId must be non-null.
  - `Tenant`: Row applies tenant-wide. Visible only to unscoped (admin) callers.
- `resellerId` (string(uuid)): Owning reseller, set only for a reseller-scoped destination. (nullable)
- `merchantId` (string(uuid)): Owning merchant, set only for a merchant-scoped destination. (nullable)
- `suppression` ([DestinationSuppressionStateDto](https://devportal.demo.winkpg.io/docs/api/models/DestinationSuppressionStateDto.md)): Durable suppression state for this destination's endpoint, or `null` when the endpoint has  never failed (or when the transport type has no endpoint concept).
  Fields:
  - `suppressionId` (string(uuid)): The suppression record's id, for correlating this state with the row on the suppressions  management grid or in the suppressions API.
  - `isActivelySuppressed` (boolean): Whether deliveries are being skipped right now.
  - `reason` ([DestinationSuppressionReason](https://devportal.demo.winkpg.io/docs/api/models/DestinationSuppressionReason.md)): Why the endpoint was suppressed. Null when the row is only tracking failures. (nullable)
    Values:
    - `ConsecutiveFailures`: The endpoint failed the configured number of sustained consecutive delivery attempts.
    - `PermanentHttpError`: The endpoint returned a permanent (non-retryable) HTTP client error (a 4xx other than 401 / 403 / 408 / 429), signalling the request is wrong-by-construction (URL gone, payload refused) and will keep failing the same way on retry.
    - `Manual`: An administrator suppressed the endpoint manually.
    - `AuthRejection`: The endpoint repeatedly rejected our credentials (401 Unauthorized or 403 Forbidden). Kept distinct from PermanentHttpError so an operator can tell an auth-plane problem (expired secret, WAF rule, IP allowlist) from an endpoint that is genuinely gone: the two call for completely different remediation. Unlike a gone endpoint, this is never applied on a single response and carries a shorter expiry.
  - `suppressedAtUtc` (string(date-time)): UTC timestamp at which the endpoint became suppressed. (nullable)
  - `expiresAtUtc` (string(date-time)): UTC timestamp at which the suppression auto-expires and the endpoint is re-probed. Null means  it never auto-expires and only a manual clear will resume delivery. (nullable)
  - `consecutiveFailures` (integer(int32)): Consecutive hard failures recorded against the endpoint.
- `concurrencyStamp` (string): (nullable)
- `tenantId` (string(uuid)): (nullable)
- `entityVersion` (integer(int32))

### 403

Forbidden

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 401

Unauthorized

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad Request

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": "null",
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 404

Not Found

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": "null",
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 501

Not Implemented

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 500

Internal Server Error

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 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](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

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

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

Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

Properties:
- `type` (string) required: 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` (string) required: A short, human-readable summary of the problem type. (nullable)
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable)
- `retryAfterSeconds` (integer(int32)) required: 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.

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

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

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

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/notifications/destinations" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "",
  "type": {},
  "configJson": ""
}'
```

### PowerShell

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

$body = @'
{
  "name": "",
  "type": {},
  "configJson": ""
}
'@

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

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

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

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

const { data } = await api.notificationsCreateDestinations({
  "name": "",
  "type": {},
  "configJson": ""
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/notifications/destinations', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "",
    "type": {},
    "configJson": ""
  }),
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
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<NotificationDestinationCreateDto>("""
    {
      "name": "",
      "type": {},
      "configJson": ""
    }
    """);

var result = await api.NotificationsCreateDestinationsAsync(body);
```

### C# (raw HTTP)

```csharp
using System.Text;

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

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

request.Content = new StringContent("""
    {
      "name": "",
      "type": {},
      "configJson": ""
    }
    """, Encoding.UTF8, "application/json");

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

### Python (SDK)

```bash
pip install winkpg-api
```

```python
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.NotificationDestinationCreateDto.from_dict({
      "name": "",
      "type": {},
      "configJson": ""
    })
    result = api.notifications_create_destinations(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "name": "",
  "type": {},
  "configJson": ""
}

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

## See also

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