View as Markdown

List Webhooks

GET/v2/webhooks

The workspace's webhook subscriptions, newest first. Secrets are never listed. Free: no credits.

Query parameters

  • pageintegeroptionalmin: 1max: 1000default: 1

    The page, 1-based.

  • per_pageenumoptionaldefault: 25

    Items per page.

    Allowed values: 25 50 100

  • statusenumoptional

    active receives events, paused was paused by a member, disabled was stopped by GetProspect (see disabled_reason).

    Allowed values: active paused disabled

Responses

  • 200 One page of webhooks.
  • 400 A query parameter out of range or unknown (VALIDATION_ERROR).
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 500 Unexpected server error.

For error handling see Errors. Response objects are described in Person object and Company object.