Skip to content

Add definitions for initial webhooks #777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
blewisCycle merged 1 commit into from
Jan 2, 2026
Merged

Add definitions for initial webhooks #777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions components/schemas/environments/EnvironmentMonitoringConfig.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ properties:
- type: object
properties:
endpoint:
description: Configuration options for pushing metrics externally.
description: >
Configuration options for pushing metrics externally.

For payload see webhook `environmentMetricsPush`
oneOf:
- type: object
required:
Expand All @@ -49,7 +52,10 @@ properties:
- type: object
properties:
endpoint:
description: Configuration options for pushing events externally.
description: >
Configuration options for pushing events externally.

For payload see webhook `environmentEventsPush`
oneOf:
- type: object
required:
Expand Down
27 changes: 27 additions & 0 deletions platform/api.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -768,6 +768,7 @@ paths:
$ref: paths/utils/resource/lookup.yml
"/v1/utils/components/lookup":
$ref: paths/utils/components/lookup.yml

components:
securitySchemes:
bearerAuth:
Expand All @@ -779,3 +780,29 @@ components:
in: header
type: apiKey
description: Defines the scope of the request to a specific Hub.

webhooks:
environmentMetricsPush:
post:
operationId: environmentMetricsPush
summary: Environment Metrics Push
description: Regularly sends metrics from an environment to an endpoint.
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: ../components/schemas/monitoring/Metric.yml
environmentEventsPush:
post:
operationId: environmentEventsPush
summary: Environment Events Push
description: Regularly sends events from an environment to an endpoint.
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: ../components/schemas/monitoring/events/Event.yml