Webhook Internal API - v1beta1 (v1beta1)

API for registering and managing HTTP webhooks and subscriptions.

Download OpenAPI description

webhook-v1beta1-internal-api.json

webhook-v1beta1-internal-api.yaml

Overview

License

HPE License

Servers

Mock server

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

http://unified-events-registration-service.unified-events.svc.cluster.local:5000/

Webhooks

Everything about Webhooks

Operations

Subscriptions

Everything about Subscriptions

Operations

Get all subscriptions

Request

Retrieves a list of subscriptions, 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-internal-api/internal-events/v1beta1/subscriptions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

subscriptions retrieved successfully.

Bodyapplication/json

idstring(uuid)required

Unique identifier of the subscription.

workspaceIdstring(uuid)required

resourceUristringrequired

URI to the subscription.

eventTypestringrequired

The eventType assosciated with subscriptions

hpePrincipalstringrequired

Security principal subject notation.

createdBystringrequired

The user that created the subscription.

createdAtstring(date-time)required

The date and time the subscription is created.

updatedBystringrequired

The user that updated the subscription.

updatedAtstring(date-time)required

The last date and time the subscription is updated.

generationinteger>= 0required

Monotonically increasing update counter to track the subscription version.

statusstringrequired

status of the webhook

Default "enabled"

Enum"enabled""disabled"

eventFilterstring

The filter to apply to events. Filtering Standard

Response

application/json

{
  "id": "0908777a-788f-45da-afb8-295c626e4d14",
  "workspaceId": "0908777a-788f-45da-afb8-295c626e4d14",
  "resourceUri": "/events/v1beta1/subscriptions/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "eventType": "string",
  "hpePrincipal": "user:<opaque-global-id>",
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "generation": 1,
  "status": "enabled",
  "eventFilter": "createdAt lt 2021-05-12T07:20:00.00Z"
}