Sign in
Notifications

Create a notification channel

Create a new notification channel.

post/api/v1/notification/channels

Request body

customHeadersobject

Custom HTTP headers sent as part of the webhook request.

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.

namestring required

User friendly name of the channel.

signingSecretstring

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

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

type'WEBHOOK' required

Notification channel type.

urlstring required

Webhook URL where the notification is sent.

Example request

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

Response

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

annotationsAnnotations

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

createdAtstring date-time required

Timestamp of when the resource was created.

customHeadersobject

Custom HTTP headers sent as part of the webhook request.

deletedAtstring date-time

Timestamp of when the resource was permanently deleted.

disabledboolean

Whether the channel is disabled or not.

idstring required

Identifies the notification channel.

metadataMetadata

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

namestring required

User friendly name of the channel.

signingSecretstring

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

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

type'WEBHOOK' required

Notification channel type.

updatedAtstring date-time required

Timestamp of when the resource was last updated.

urlstring required

Webhook URL where the notification is sent.

Example response

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.