Skip to content
Internal API Catalog
/
Webhook API - v1beta1
/
API reference
/
Webhooks

Webhook API - v1beta1 (v1beta1)

API for registering and managing HTTP webhooks and subscriptions.

Download OpenAPI description
webhook-v1beta1-nbapi.json
webhook-v1beta1-nbapi.yaml
Overview
License

HPE License

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/event/public/openapi/webhook-v1beta1/webhook-v1beta1-nbapi/

https://global.api.greenlake.hpe.com/

Webhooks

Everything about Webhooks

Operations

Register a new webhook

Request

This endpoint allows clients to create a new webhook to establish a callback mechanism for key events on GLCP services.

Security
Bearer
Bodyapplication/jsonrequired

Webhook payload

namestringrequired

The name of the webhook.

destinationstringrequired

The URL where events will be sent.

descriptionstring

A brief description of the webhook.

secretstring

A secret for verifying the authenticity of incoming requests.

secondarySecretstring

A secret for verifying the authenticity of incoming requests.

authTypestring

Authentication Type Oauth or APIKey

Enum"Oauth""APIKey"""
clientIdstring

Client Id used for Oauth authnetication

clientSecretstring

Client Secret used for Oauth Authentication

issuerUrlstring

Token issuer endpoint

apiKeystring

Api Key used for authentication from client endpoint

batchingboolean

Indicates whether the webhook uses batching.

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/event/public/openapi/webhook-v1beta1/webhook-v1beta1-nbapi/events/v1beta1/webhooks \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "License Notification",
    "description": "Webhook for receiving license notifications",
    "destination": "https://example.com/new-endpoint",
    "secret": "s3cr3tKey"
  }'

Responses

Webhook successfully registered.

Headers
Locationstring(uri-reference)

URI to get details of the webhook creation operation.

Examples:
/events/v1beta1/webhooks/123e4567-e89b-12d3-a456-426614174000
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",
  "resourceUri": "/events/v1beta1/webhooks/123e4567-e89b-12d3-a456-426614174000",
  "generation": 1,
  "hpePrincipal": "user:<opaque-global-id>",
  "createdBy": "sample.user@example.com",
  "createdAt": "2024-04-29T15:25:06.194Z",
  "updatedAt": "2024-04-29T15:25:06.194Z",
  "clientId": "0908777a-788f-45da-afb8-295c626e4d14",
  "issuerUrl": "https://example.com/new-endpoint",
  "authType": "Oauth",
  "dualSecret": false,
  "batching": false
}

Get all webhooks

Request

Retrieves a list of webhooks, organized in descending order based on their creation time.

Pagination: This endpoint exclusively supports offset-based pagination.

Security
Bearer
Query
limitinteger(int64)[ 1 .. 200 ]

Specifies the number of results to be returned. The default value is 200.

Default 200
offsetinteger(int64)>= 0

Specifies the zero-based resource offset to start the response from. The default value is 0.

Default 0
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/event/public/openapi/webhook-v1beta1/webhook-v1beta1-nbapi/events/v1beta1/webhooks \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Webhooks retrieved successfully.

Bodyapplication/json
itemsArray of objects(WebhookResponse)required
items[].​idstring(uuid)required

The unique identifier of the webhook.

items[].​typestringrequired

The type of the resource.

Value "events/webhook"
items[].​createdAtstring(date-time)required

The timestamp when the webhook was created.

items[].​updatedAtstring(date-time)required

The timestamp when the webhook was last updated

items[].​generationintegerrequired

Monotonically increasing update counter.

items[].​pausedbooleanrequired

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

Default false
items[].​namestringrequired

The name of the webhook.

items[].​destinationstringrequired

The URL where events will be sent.

items[].​hpePrincipalstringrequired

Security principal subject notation.

items[].​authTypestringrequired

type of authentication (oauth,apikey)

items[].​clientIdstringrequired

ClientId used for generating bearer token for verification

items[].​issuerUrlstringrequired

The token generating url

items[].​createdBystringrequired

The user that created the webhook.

items[].​descriptionstringrequired

A brief description of the webhook.

items[].​resourceUristringrequired

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

items[].​statusstringrequired

Controlled by System only

Default "PENDING"
Enum"ACTIVE""DISABLED""PENDING"
items[].​dualSecretbooleanrequired

Indicates whether the webhook uses dual secret authentication.

Default false
items[].​batchingbooleanrequired

Indicates whether the webhook uses batching.

Default false
items[].​stateReasonstring

The reason for the current state of the webhook.

countintegerrequired
offsetintegerrequired
totalintegerrequired
Response
application/json
{
  "items": [
    { … }
  ],
  "count": 0,
  "offset": 0,
  "total": 0
}

Get a webhook by ID

Request

Retrieve detailed information about a specific webhook by its unique identifier

Security
Bearer
Path
idstring(uuid)required

Webhook ID

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

Get specific webhook

0908777a-788f-45da-afb8-295c626e4d14
curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/event/public/openapi/webhook-v1beta1/webhook-v1beta1-nbapi/events/v1beta1/webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Webhook retrieved 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
}

Update a webhook by ID

Request

Update an existing webhook's settings, such as its name, description, destination, etc

Security
Bearer
Path
idstring(uuid)required

Webhook ID

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

Update specific webhook

0908777a-788f-45da-afb8-295c626e4d14
Bodyapplication/merge-patch+jsonrequired
namestring

The name of the webhook.

descriptionstring

A brief description of the webhook.

destinationstring

The URL where events will be sent.

secretstring

A secret for verifying the authenticity of incoming requests.

secondarySecretstring

A secret for verifying the authenticity of incoming requests.

pausedboolean

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

Default false
authTypestring

Authentication Type Oauth or APIKey

Enum"Oauth""APIKey"""
clientIdstring

Client Id used for Oauth authnetication

clientSecretstring

Client Secret used for Oauth Authentication

issuerUrlstring

Token issuer endpoint

apiKeystring

Api Key used for authentication from client endpoint

batchingboolean

Indicates whether the webhook uses batching.

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

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
}

Delete a webhook by ID

Request

Remove a specific webhook from the system

Security
Bearer
Path
idstring(uuid)required

Webhook ID

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

Delete specific webhook

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

The force query parameter is used to force deletion in situations where the webhook has one or more subscriptions.

Default false
curl -i -X DELETE \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/event/public/openapi/webhook-v1beta1/webhook-v1beta1-nbapi/events/v1beta1/webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

No Content

Response
No content

Webhook Verification Endpoint

Request

This endpoint is designed to ensure the webhook URL provided by the user is correct and the server is prepared to receive webhook requests.

Security
Bearer
Path
idstring(uuid)required

Webhook ID

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

Verify specific webhook

0908777a-788f-45da-afb8-295c626e4d14
curl -i -X POST \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/event/public/openapi/webhook-v1beta1/webhook-v1beta1-nbapi/events/v1beta1/webhooks/{id}/verify' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Webhook validated 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.

destinationResponseobject(DestinationResponse)

The response from the destination URL.

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,
  "destinationResponse": {
    "statusCode": 0,
    "message": "OK",
    "requestedRate": 0
  }
}

Fetch recent webhook deliveries

Request

This endpoint is dedicated to retrieve detailed information about recent deliveries for a specific webhook.

Security
Bearer
Path
idstring(uuid)required

Webhook ID

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

Get recent deliveries for specific webhook

0908777a-788f-45da-afb8-295c626e4d14
Query
limitinteger(int64)[ 1 .. 200 ]

Specifies the number of results to be returned. The default value is 200.

Default 200
offsetinteger(int64)>= 0

Specifies the zero-based resource offset to start the response from. The default value is 0.

Default 0
curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/event/public/openapi/webhook-v1beta1/webhook-v1beta1-nbapi/events/v1beta1/webhooks/{id}/recent-deliveries' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Recent deliveries retrieved successfully.

Bodyapplication/json
itemsArray of objects(RecentDeliveryResponse)required

An array of failure response objects that detail each failed delivery attempt associated with a specific webhook.

items[].​idstring(uuid)required

Unique identifier of the delivery. For batch deliveries, this is the batch ID; for single deliveries, the cloudevent ID.

items[].​typestringrequired

The type of the resource.

Value "events/deliveryFailure"
items[].​httpResponseCodeinteger(int32)required

HTTP Error Code returned by the destination

items[].​createdAtstring(date-time)required

The date and time the webhook delivery happened.

items[].​requestHeadersobjectrequired

Headers included in the webhook's request.

items[].​requestHeaders.​property name*Array of stringsadditional property
items[].​requestBodyobjectrequired

A single object payload.

items[].​responseBodystringrequired

The body of the response from the webhook.

items[].​statusstringrequired

Controlled by System only

Default "SUCCESS"
Enum"SUCCESS""FAILURE"
items[].​retryStatusstringrequired

Indicates whether the delivery can be retried

Default "NORETRY"
Enum"NORETRY""RETRY"
items[].​updatedAtstring(date-time)required

The timestamp when the delivery was last updated

items[].​generationintegerrequired

Monotonically increasing update counter.

items[].​descriptionstringrequired

Human-readable description of the delivery. For single event deliveries, this is the event type. For batch deliveries, this is a string like "Batch of 10 events".

items[].​resourceUristring

URI to the delivery failure.

Value "/events/v1beta1/webhooks/{webhookId}"
items[].​responseHeadersobject

Headers included in the webhook's response.

items[].​subjectstring

The cloud event subject.

items[].​failureIdstring(uuid)

Unique identifier of the delivery failure.

countintegerrequired

The number of failure response objects contained in the items array for the current response.

offsetintegerrequired

The zero-based index in the complete list of failures that marks the start of the current set of data.

totalintegerrequired

The total number of delivery failures recorded in the system that match the provided query or filters.

Response
application/json
{
  "items": [
    { … }
  ],
  "count": 0,
  "offset": 0,
  "total": 0
}

Retry webhook delivery failures

Request

This endpoint is dedicated to retry delivery failures for a specific webhook.

Security
Bearer
Path
idstring(uuid)required

Webhook ID

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

Get specific webhook delivery failures

0908777a-788f-45da-afb8-295c626e4d14
failureIdstring(uuid)required

Webhook Failure ID

Default "a4831e24-c536-4719-88ca-2afe5a959237"
Examples:

Retry specific webhook delivery failures

a4831e24-c536-4719-88ca-2afe5a959237
curl -i -X POST \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/event/public/openapi/webhook-v1beta1/webhook-v1beta1-nbapi/events/v1beta1/webhooks/{id}/delivery-failures/{failureId}/retry' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Delivery failures retried submitted.

Bodyapplication/json
idstring(uuid)required

Unique identifier of the delivery failure.

typestringrequired

The type of the resource.

Value "events/deliveryFailure"
httpResponseCodeinteger(int32)required

HTTP Error Code returned by the destination

resourceUristringrequired

URI to the delivery failure.

Value "/events/v1beta1/webhooks/{webhookId}"
requestHeadersobjectrequired

Headers included in the webhook's request.

requestBodyobjectrequired

The body of the request from the webhook.

responseHeadersobjectrequired

Headers included in the webhook's response.

responseBodystringrequired

The body of the response from the webhook.

createdAtstring(date-time)required

The date and time the webhook failure happened.

updatedAtstring(date-time)required

The timestamp when the delivery failure was last updated

generationintegerrequired

Monotonically increasing update counter.

failureIdstring(uuid)required

Unique identifier of the delivery failure.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "events/deliveryFailure",
  "httpResponseCode": 0,
  "resourceUri": "/events/v1beta1/webhooks/{webhookId}",
  "requestHeaders": {
    "Content-Type": "application/json"
  },
  "requestBody": {
    "cloudEvents": "data"
  },
  "responseHeaders": {
    "Content-Type": "application/json"
  },
  "responseBody": {
    "error": "Internal processing error"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "generation": 1,
  "failureId": "123e4567-e89b-12d3-a456-426614174000"
}

Subscriptions

Everything about Subscriptions

Operations