Convoy · Schema

Convoy EventType

A declared event type within a project, optionally with a JSON Schema for payload validation.

WebhookWebhook GatewayEvent DeliveryEventingMessagingIntegrationAPI Infrastructure

Properties

Name	Type	Description
category	string
deprecated_at	string
description	string
json_schema	array
name	string
uid	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/convoy/json-schema/convoy-event-type-schema.json",
  "title": "Convoy EventType",
  "description": "A declared event type within a project, optionally with a JSON Schema for payload validation.",
  "properties": {
    "category": {
      "type": "string"
    },
    "deprecated_at": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "json_schema": {
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "name": {
      "type": "string"
    },
    "uid": {
      "type": "string"
    }
  },
  "type": "object"
}