Webhook Subscriptions

Retrieve a webhook subscription

Changed on

Returns the webhook subscription identified by webhook_id, including the URL it calls, the subscription types it covers, and whether it is enabled.

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

get/webhooks/{webhook_id}

Request

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

Response

Returns a webhook subscription object if a valid webhook subscription object ID was provided.

idstring uuid required

Webhook unique identifier.

created_atstring date-time required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

updated_atstring date-time required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

titlestring required

Title of the webhook for use on tenant side.

urlstring url required

The callback URL to be called by the webhook.

enabledboolean required

Enable/disable webhook.

typestring[] required

Subscription types to receive webhooks for.

exclude_typestring[]

Subscription types to exclude when type is ALL.

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