Webhook Subscriptions

Create a webhook subscription

Changed on

Creates a webhook subscription, registering a URL that the Investment API calls when the events you select occur.

The URL must use HTTPS, resolve to a DNS name rather than an IP address, serve TLS 1.2 or higher, and must not respond with a redirect. Set type to ALL to receive every event, optionally narrowing it with exclude_type, or list only the subscription types you want. Events are batched by size or by delay according to config.

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

post/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:admin)

Request body

titlestring required

Title of the webhook for use on tenant side.

urlstring url required

The callback URL to be called by the webhook.

typestring[]

Subscription types to receive webhooks for.

exclude_typestring[]

Subscription types to exclude when type is ALL.

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

    • info

      added the new CASH_BALANCE_TRANSFER enum value to the request property /

    • info

      added the new CASH_BALANCE_TRANSFER enum value to the request property /