Upvest · JSON Structure

Investment Api Webhook Subscription Create Structure

Request body for creating a webhook subscription.

Type: object Properties: 2 Required: 2
Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

WebhookSubscriptionCreate is a JSON Structure definition published by Upvest, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

url event_categories

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-create-structure.json",
  "name": "WebhookSubscriptionCreate",
  "description": "Request body for creating a webhook subscription.",
  "type": "object",
  "properties": {
    "url": {
      "type": "uri",
      "description": "The HTTPS endpoint URL. Must use TLS 1.2 or higher.",
      "example": "https://example.com"
    },
    "event_categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The event categories to subscribe to.",
      "example": [
        "example-value"
      ]
    }
  },
  "required": [
    "url",
    "event_categories"
  ]
}