Upvest · JSON Structure

Investment Api Webhook Subscription Update Structure

Request body for updating a webhook subscription.

Type: object Properties: 3
Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

WebhookSubscriptionUpdate is a JSON Structure definition published by Upvest, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

url event_categories status

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-structure/investment-api-webhook-subscription-update-structure.json",
  "name": "WebhookSubscriptionUpdate",
  "description": "Request body for updating a webhook subscription.",
  "type": "object",
  "properties": {
    "url": {
      "type": "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"
    }
  }
}