Update a webhook status by ID

Request

Update an existing webhook's status

Security

Bearer

Path

webhookIdstring(uuid)required

Webhook ID

Default "0908777a-788f-45da-afb8-295c626e4d14"

Examples:

Example with specific webhook ID

Update specific webhook

0908777a-788f-45da-afb8-295c626e4d14

Bodyapplication/merge-patch+jsonrequired

statusstringrequired

Controlled by System only

Default "PENDING"

Enum"ACTIVE""WARNING""ERROR"

curl -i -X PATCH \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/event/public/openapi/webhook-v1beta1/webhook-v1beta1-internal-api/internal-events/v1beta1/webhooks/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "status": "ERROR"
  }'

Responses

Webhook updated successfully.

Bodyapplication/json

idstring(uuid)required

The unique identifier of the webhook.

typestringrequired

The type of the resource.

Value "events/webhook"

createdAtstring(date-time)required

The timestamp when the webhook was created.

updatedAtstring(date-time)required

The timestamp when the webhook was last updated

generationintegerrequired

Monotonically increasing update counter.

pausedbooleanrequired

Indicates whether the webhook is paused. false means the webhook is not paused.

Default false

namestringrequired

The name of the webhook.

destinationstringrequired

The URL where events will be sent.

hpePrincipalstringrequired

Security principal subject notation.

authTypestringrequired

type of authentication (oauth,apikey)

clientIdstringrequired

ClientId used for generating bearer token for verification

issuerUrlstringrequired

The token generating url

createdBystringrequired

The user that created the webhook.

descriptionstringrequired

A brief description of the webhook.

resourceUristringrequired

URI to the resource itself (i.e. a self link).

statusstringrequired

Controlled by System only

Default "PENDING"

Enum"ACTIVE""DISABLED""PENDING"

dualSecretbooleanrequired

Indicates whether the webhook uses dual secret authentication.

Default false

batchingbooleanrequired

Indicates whether the webhook uses batching.

Default false

stateReasonstring

The reason for the current state of the webhook.

Response

application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "events/webhook",
  "name": "License Notification",
  "description": "Webhook for receiving license notifications",
  "destination": "https://example.com/new-endpoint",
  "paused": false,
  "status": "ACTIVE",
  "stateReason": "Failure in Event Deliveries",
  "resourceUri": "/events/v1beta1/webhooks/123e4567-e89b-12d3-a456-426614174000",
  "generation": 1,
  "hpePrincipal": "user:<opaque-global-id>",
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "authType": "oauth",
  "clientId": "a822f43a-9e72-4a04-8476-ad00422b987f",
  "issuerUrl": "http://example.com'",
  "dualSecret": false,
  "batching": false
}

Webhook Internal API - v1beta1 (v1beta1)

Webhooks