Webhook Subscriptions

List all webhook subscriptions

Changed on

Returns the list of webhook subscriptions.

Use the offset and limit query parameters to page through results; meta.total_count gives the total number of matching subscriptions.

See the implementing webhooks guide (TOL / BYOL / Omnibus) for handler requirements, subscription types, and batching.

get/webhooks

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/webhooks
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: webhooks:read, webhooks:admin)

Query parameters

sort'created_at' | 'updated_at' | 'title' | 'url' | 'enabled'

Sort the result by created_at, updated_at, title, url, or enabled.

order'ASC' | 'DESC'

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

offsetinteger

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

limitinteger

Use the limit argument to specify the maximum number of items returned.

Response

An object with a data property that contains an array of webhook subscription objects.

Changes

  • eca7a0f6c929Revision changes
    • warning

      added the new CASH_BALANCE_TRANSFER enum value to the /// response property for the response status

    • warning

      added the new CASH_BALANCE_TRANSFER enum value to the /// response property for the response status