Skip to content
Hayonix

API reference · Schema

WebhookEventType

  • objectstringrequired

    Always `webhook_event_type`: the type of this object

    One ofwebhook_event_type

  • typestringrequired

    The event type, as listed in `event_types`

  • productstringrequired

    Product the event belongs to

  • product_labelstringrequired

    Product 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 ofprojectorg

  • subscribablebooleanrequired

    Whether it can be listed in `event_types` (false for the test event, which is only sent on request)

  • summarystringrequired

    When the event is sent, in one sentence

  • data_schemaobjectrequired

    JSON 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