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

System Webhook API - v1beta1 (v1beta1)

API for registering and managing HTTP webhooks and subscriptions.

Download OpenAPI description
system-webhook-v1beta1-nbapi.json
system-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/system-webhook-v1beta1-nbapi/

Hoku endpoint(Dev)

https://hoku-ext-api.ccs.arubathena.com/

Polaris endpoint(QA)

https://polaris-default-ext-api.ccs.arubathena.com/

Mira endpoint(QA)

https://mira-default-ext-api-api.ccs.arubathena.com/

Pavo endpoint(Staging)

https://pavo-default-ext-api.common.cloud.hpe.com/

Aquila endpoint(Production)

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.

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

Responses

Webhook successfully registered.

Headers
Locationstring(uri-reference)

URI to get details of the webhook creation operation.

Examples:
/events/v1beta1/system-webhooks/123e4567-e89b-12d3-a456-426614174000
Bodyapplication/json
idstring(uuid)required

The unique identifier of the webhook.

namestringrequired

The name of the webhook.

typestringrequired

The type of the resource.

Value "events/webhook"
destinationstringrequired

The URL where events will be sent.

hpePrincipalstringrequired

Security principal subject notation.

resourceUristringrequired

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

generationintegerrequired

Monotonically increasing update counter.

createdBystringrequired

The user that created the webhook.

createdAtstring(date-time)required

The timestamp when the webhook was created.

updatedBystringrequired

The user that updated the webhook.

updatedAtstring(date-time)required

The timestamp when the webhook was last updated

Response
application/json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "License Notification",
  "type": "events/webhook",
  "destination": "https://example.com/new-endpoint",
  "hpePrincipal": "user:<opaque-global-id>",
  "resourceUri": "/events/v1beta1/system-webhooks/123e4567-e89b-12d3-a456-426614174000",
  "generation": 1,
  "createdBy": "sample.user@example.com",
  "createdAt": "2024-04-29T15:25:06.194Z",
  "updatedBy": "sample.user@example.com",
  "updatedAt": "2024-04-29T15:25:06.194Z"
}

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/system-webhook-v1beta1-nbapi/events/v1beta1/system-webhooks \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Webhooks retrieved successfully.

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

The unique identifier of the webhook.

items[].​namestringrequired

The name of the webhook.

items[].​typestringrequired

The type of the resource.

Value "events/webhook"
items[].​destinationstringrequired

The URL where events will be sent.

items[].​hpePrincipalstringrequired

Security principal subject notation.

items[].​resourceUristringrequired

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

items[].​generationintegerrequired

Monotonically increasing update counter.

items[].​createdBystringrequired

The user that created the webhook.

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

The timestamp when the webhook was created.

items[].​updatedBystringrequired

The user that updated the webhook.

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

The timestamp when the webhook was last updated

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/system-webhook-v1beta1-nbapi/events/v1beta1/system-webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Webhook retrieved successfully.

Bodyapplication/json
idstring(uuid)required

The unique identifier of the webhook.

namestringrequired

The name of the webhook.

typestringrequired

The type of the resource.

Value "events/webhook"
destinationstringrequired

The URL where events will be sent.

hpePrincipalstringrequired

Security principal subject notation.

resourceUristringrequired

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

generationintegerrequired

Monotonically increasing update counter.

createdBystringrequired

The user that created the webhook.

createdAtstring(date-time)required

The timestamp when the webhook was created.

updatedBystringrequired

The user that updated the webhook.

updatedAtstring(date-time)required

The timestamp when the webhook was last updated

Response
application/json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "License Notification",
  "type": "events/webhook",
  "destination": "https://example.com/new-endpoint",
  "hpePrincipal": "user:<opaque-global-id>",
  "resourceUri": "/events/v1beta1/system-webhooks/123e4567-e89b-12d3-a456-426614174000",
  "generation": 1,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

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.

destinationstring

The URL where events will be sent.

curl -i -X PATCH \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/event/public/openapi/webhook-v1beta1/system-webhook-v1beta1-nbapi/events/v1beta1/system-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.

namestringrequired

The name of the webhook.

typestringrequired

The type of the resource.

Value "events/webhook"
destinationstringrequired

The URL where events will be sent.

hpePrincipalstringrequired

Security principal subject notation.

resourceUristringrequired

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

generationintegerrequired

Monotonically increasing update counter.

createdBystringrequired

The user that created the webhook.

createdAtstring(date-time)required

The timestamp when the webhook was created.

updatedBystringrequired

The user that updated the webhook.

updatedAtstring(date-time)required

The timestamp when the webhook was last updated

Response
application/json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "License Notification",
  "type": "events/webhook",
  "destination": "https://example.com/new-endpoint",
  "hpePrincipal": "user:<opaque-global-id>",
  "resourceUri": "/events/v1beta1/system-webhooks/123e4567-e89b-12d3-a456-426614174000",
  "generation": 1,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

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/system-webhook-v1beta1-nbapi/events/v1beta1/system-webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

No Content

Response
No content

Subscriptions

Everything about Subscriptions

Operations