webhook_receiver_create

Create webhook receiver
post/v1/webhook-receivers

Request Body

Create-time identity-related parameters

Object
description
endpoint

The URL that webhook notification requests should be sent to

name

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

secrets

A non-empty list of secret keys used to sign webhook payloads.

subscriptions

A list of webhook event class subscriptions.

If this list is empty or is not included in the request body, the webhook will not be subscribed to any events.

A webhook event class subscription matches either a single event class exactly, or a glob pattern including wildcards that may match multiple event classes

Responses

Object
description

human-readable free-form text about a resource

endpoint

The URL that webhook notification requests are sent to.

id

unique, immutable, system-controlled identifier for each resource

name

unique, mutable, user-controlled identifier for each resource

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

secrets

A view of a shared secret key assigned to a webhook receiver.

Once a secret is created, the value of the secret is not available in the API, as it must remain secret. Instead, secrets are referenced by their unique IDs assigned when they are created.

Object
id

The public unique ID of the secret.

time_created

The UTC timestamp at which this secret was created.

subscriptions

The list of alert classes to which this receiver is subscribed.

A webhook event class subscription matches either a single event class exactly, or a glob pattern including wildcards that may match multiple event classes

time_created

timestamp when this resource was created

time_modified

timestamp when this resource was last modified