Convoy · JSON Structure

Convoy Subscription Structure

Binds a source and/or filter to one or more endpoints.

Type: object Properties: 16
WebhooksWebhook GatewayEvent DeliveryEventingMessagingIntegrationAPI Infrastructure

Convoy Subscription Structure is a JSON Structure definition published by Convoy, describing 16 properties. It conforms to the https://json-structure.org/draft/2024-01/structure meta-schema.

Properties

alert_config created_at deleted_at delivery_mode device_metadata endpoint_metadata filter_config function name project_id rate_limit_config retry_config source_metadata type uid updated_at

Meta-schema: https://json-structure.org/draft/2024-01/structure

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/draft/2024-01/structure",
  "$id": "https://api-evangelist.github.io/convoy/json-structure/convoy-subscription-structure.json",
  "title": "Convoy Subscription",
  "description": "Binds a source and/or filter to one or more endpoints.",
  "type": "object",
  "properties": {
    "alert_config": {
      "description": "subscription config"
    },
    "created_at": {
      "description": "",
      "type": "string"
    },
    "deleted_at": {
      "description": "",
      "type": "string"
    },
    "delivery_mode": {
      "description": "",
      "type": "string",
      "enum": [
        {
          "type": "object"
        },
        {
          "type": "object"
        }
      ]
    },
    "device_metadata": {
      "description": "",
      "type": "object"
    },
    "endpoint_metadata": {
      "description": "",
      "type": "object"
    },
    "filter_config": {
      "description": "",
      "type": "object"
    },
    "function": {
      "description": "",
      "type": "string"
    },
    "name": {
      "description": "",
      "type": "string"
    },
    "project_id": {
      "description": "",
      "type": "string"
    },
    "rate_limit_config": {
      "description": "",
      "type": "object"
    },
    "retry_config": {
      "description": "",
      "type": "object"
    },
    "source_metadata": {
      "description": "",
      "type": "object"
    },
    "type": {
      "description": "",
      "type": "string",
      "enum": [
        {
          "type": "object"
        },
        {
          "type": "object"
        }
      ]
    },
    "uid": {
      "description": "",
      "type": "string"
    },
    "updated_at": {
      "description": "",
      "type": "string"
    }
  }
}