WSO2 · JSON Structure

Devportal Api Webhook Subscription Structure

WebhookSubscription schema from WSO2 API Manager

Type: object Properties: 6
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Webhook Subscription is a JSON Structure definition published by WSO2, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

apiId appId topic callBackUrl deliveryTime deliveryStatus

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/wso2/refs/heads/main/json-structure/devportal-api-webhook-subscription-structure.json",
  "name": "Webhook Subscription",
  "description": "WebhookSubscription schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "apiId": {
      "type": "string",
      "example": "faae5fcc-cbae-40c4-bf43-89931630d313"
    },
    "appId": {
      "type": "string",
      "example": "faae5fcc-cbae-40c4-bf43-89931630d313"
    },
    "topic": {
      "type": "string",
      "example": "orderBooks"
    },
    "callBackUrl": {
      "type": "string",
      "example": "www.orderbooksite.com"
    },
    "deliveryTime": {
      "type": "string",
      "example": "faae5fcc-cbae-40c4-bf43-89931630d313"
    },
    "deliveryStatus": {
      "type": "int32",
      "example": 1
    }
  }
}