API Reference / Web Hooks

GET /webhooks

Get all webhooks (associated with the logged API user's account)

Returns the account's webhook subscriptions — each endpoint, its secret and the events it receives.

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • webhooksarray<object>
      array item fields →
      • idstringbson-id

        ID of the webhook

      • namestring

        Name of the webhook

      • hook_urlstring

        URL of the webhook

      • secretkeystring

        Secret key of the webhook

    • total_countintegerint32

      Total number of items

    • pageintegerint32

      Current page number

    • per_pageintegerint32

      Number of items returned in each page

    • max_pageintegerint32

      The page number of the last page of items

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides