Sign in

v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB
Notifications

Create a notification channel

Create a new notification channel.

post/api/v1/notification/channels

Request body

type'WEBHOOK' required

Notification channel type.

namestring required

User friendly name of the channel.

disabledboolean

Whether the channel is disabled or not.

metadataMetadata

Set of key-value pairs. Metadata can be used to store additional information about a resource.

urlstring required

Webhook URL where the notification is sent.

customHeadersobject

Custom HTTP headers sent as part of the webhook request.

signingSecretstring

Signing secret used for webhook request validation on the receiving end.

Format: base64 encoded random bytes optionally prefixed with whsec_. Recommended size: 24

Example request

{
  "name": "customer-webhook",
  "disabled": true,
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "url": "https://example.com/webhook",
  "signingSecret": "whsec_S6g2HLnTwd9AhHwUIMFggVS9OfoPafN8"
}

Response

The request has succeeded and a new resource has been created as a result.

createdAtstring date-time required

Timestamp of when the resource was created.

updatedAtstring date-time required

Timestamp of when the resource was last updated.

deletedAtstring date-time

Timestamp of when the resource was permanently deleted.

idstring required

Identifies the notification channel.

type'WEBHOOK' required

Notification channel type.

namestring required

User friendly name of the channel.

disabledboolean

Whether the channel is disabled or not.

annotationsAnnotations

Set of key-value pairs managed by the system. Cannot be modified by user.

metadataMetadata

Set of key-value pairs. Metadata can be used to store additional information about a resource.

urlstring required

Webhook URL where the notification is sent.

customHeadersobject

Custom HTTP headers sent as part of the webhook request.

signingSecretstring

Signing secret used for webhook request validation on the receiving end.

Format: base64 encoded random bytes optionally prefixed with whsec_. Recommended size: 24

Example response

{
  "createdAt": "2024-01-01T01:01:01.001Z",
  "updatedAt": "2024-01-01T01:01:01.001Z",
  "deletedAt": "2024-01-01T01:01:01.001Z",
  "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "name": "customer-webhook",
  "disabled": true,
  "annotations": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "url": "https://example.com/webhook",
  "signingSecret": "whsec_S6g2HLnTwd9AhHwUIMFggVS9OfoPafN8"
}