The event type catalog entry object

Describes a webhook event type and whether it can be selected on a webhook config at a given API version.

Each entry in the response from List event types describes one webhook event type and whether you can add it to a webhook config's event_types selection at the evaluated API version.

{
  "type": "employee.created",
  "description": "An employee was created.",
  "status": "supported",
  "selectable": true,
  "unavailable_reason": null,
  "replacement": null,
  "migration_guide_url": null,
  "retires_at": null
}
AttributeDescription
type
string
Event type identifier, in the form resource.action.
description
string
Human-readable summary of when Check sends this event type.
status
enum
Lifecycle of the event type at the evaluated API version: supported, deprecated, or retired.
selectable
boolean
Whether you can add this event type to a webhook config's event_types list at the evaluated API version.
unavailable_reason
string, nullable
Why the event type cannot be selected, or null when selectable is true.
replacement
string, nullable
Event type that supersedes this one, when status is deprecated or retired.
migration_guide_url
string, nullable
Link to migration guidance, when Check provides one for a deprecated or retired event type.
retires_at
date, nullable
Date the event type is scheduled to retire at the evaluated API version, or null when not applicable.