API reference · Schema
WebhookEventType
objectstringrequiredAlways `webhook_event_type`: the type of this object
One of
webhook_event_typetypestringrequiredThe event type, as listed in `event_types`
productstringrequiredProduct the event belongs to
product_labelstringrequiredProduct name to show people
scopestringrequired`project`: sent to the destinations of the project it happened in; `org`: an organization event, sent to destinations with `org_events: true`
One of
projectorgsubscribablebooleanrequiredWhether it can be listed in `event_types` (false for the test event, which is only sent on request)
summarystringrequiredWhen the event is sent, in one sentence
data_schemaobjectrequiredJSON Schema of the event’s `data`
Example
{
"object": "webhook_event_type",
"type": "pod.running",
"product": "pods",
"product_label": "string",
"scope": "project",
"subscribable": true,
"summary": "string",
"data_schema": {}
}Used by
- Every event type a webhook can receive, with the JSON Schema of its data
GET /v1/webhooks/event-types