Upvest · Schema

WebhookSubscriptionUpdate

Request body for updating a webhook subscription.

Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Properties

Name	Type	Description
url	string	The updated endpoint URL.
event_categories	array	The updated event categories.
status	string	Activate or deactivate the subscription.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-schema/investment-api-webhook-subscription-update-schema.json",
  "title": "WebhookSubscriptionUpdate",
  "description": "Request body for updating a webhook subscription.",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The updated endpoint URL.",
      "example": "https://example.com"
    },
    "event_categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The updated event categories.",
      "example": [
        "example-value"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "description": "Activate or deactivate the subscription.",
      "example": "ACTIVE"
    }
  }
}