Skip to main content

List webhook subscriptions

GET 
/webhooks

List webhook subscriptions

Valid event names

The eventNames array on each subscription must contain names from the canonical event vocabulary. The full list is available in the x-align-events extension on the OpenAPI spec. Common examples: entry.created, entry.status_changed, entry.commented, release.released, time.logged, agreement.signed, cost.approved.

Subscriptions that include an unrecognised event name are rejected at write time with { "error": "unknown_event_names", "invalid": [...] }.

OK

Schema

    data

    object[]

    required

  • Array [

    • iduuidrequired
    Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
    destinationUrlurirequired
    Example: https://hooks.example.com/align
    eventNamesstring[]required
    Example: ["entry.created","entry.updated"]
    enabledbooleanrequired
    Example: true
    descriptionstring | nullnullablerequired
    Example: Notify CI pipeline on entry changes.
    createdAtdate-timerequired
    Example: 2025-01-01T00:00:00Z

  • ]

    • pageintegerrequired
    Example: 1
    pageSizeintegerrequired
    Example: 25
    totalintegerrequired
    Example: 100