Upvest · Schema

WebhookSubscriptionCreate

Request body for creating a webhook subscription.

Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Properties

Name Type Description
url string The HTTPS endpoint URL. Must use TLS 1.2 or higher.
event_categories array The event categories to subscribe to.
View JSON Schema on GitHub

JSON Schema

investment-api-webhook-subscription-create-schema.json Raw ↑ 
{
  "$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-create-schema.json",
  "title": "WebhookSubscriptionCreate",
  "description": "Request body for creating a webhook subscription.",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "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"
  ]
}