Convoy · Schema

Convoy Source

An ingest source (HTTP webhook, REST API, or message broker such as Kafka, AMQP, Pub/Sub, or SQS) that emits events into Convoy.

WebhooksWebhook GatewayEvent DeliveryEventingMessagingIntegrationAPI Infrastructure

Properties

Name	Type	Description
body_function	string
created_at	string
custom_response	object
deleted_at	string
forward_headers	array
header_function	string
idempotency_keys	array
is_disabled	boolean
mask_id	string
name	string
project_id	string
provider	string
provider_config	object
pub_sub	object
type	string
uid	string
updated_at	string
url	string
verifier	object

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-source-schema.json",
  "title": "Convoy Source",
  "description": "An ingest source (HTTP webhook, REST API, or message broker such as Kafka, AMQP, Pub/Sub, or SQS) that emits events into Convoy.",
  "properties": {
    "body_function": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "custom_response": {
      "properties": {
        "body": {
          "type": "string"
        },
        "content_type": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "deleted_at": {
      "type": "string"
    },
    "forward_headers": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "header_function": {
      "type": "string"
    },
    "idempotency_keys": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "is_disabled": {
      "type": "boolean"
    },
    "mask_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "project_id": {
      "type": "string"
    },
    "provider": {
      "enum": [
        "github",
        "twitter",
        "shopify"
      ],
      "type": "string",
      "x-enum-varnames": [
        "GithubSourceProvider",
        "TwitterSourceProvider",
        "ShopifySourceProvider"
      ]
    },
    "provider_config": {
      "properties": {
        "twitter": {
          "properties": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "type": {
            "type": "object",
            "description": "deeply nested - truncated"
          }
        }
      },
      "type": "object"
    },
    "pub_sub": {
      "properties": {
        "amqp": {
          "properties": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "type": {
            "type": "object",
            "description": "deeply nested - truncated"
          }
        },
        "google": {
          "properties": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "type": {
            "type": "object",
            "description": "deeply nested - truncated"
          }
        },
        "kafka": {
          "properties": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "type": {
            "type": "object",
            "description": "deeply nested - truncated"
          }
        },
        "sqs": {
          "properties": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "type": {
            "type": "object",
            "description": "deeply nested - truncated"
          }
        },
        "type": {
          "enum": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "type": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "x-enum-varnames": {
            "type": "object",
            "description": "deeply nested - truncated"
          }
        },
        "workers": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "type": {
      "enum": [
        "http",
        "rest_api",
        "pub_sub",
        "db_change_stream"
      ],
      "type": "string",
      "x-enum-varnames": [
        "HTTPSource",
        "RestApiSource",
        "PubSubSource",
        "DBChangeStream"
      ]
    },
    "uid": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "url": {
      "type": "string"
    },
    "verifier": {
      "properties": {
        "api_key": {
          "properties": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "type": {
            "type": "object",
            "description": "deeply nested - truncated"
          }
        },
        "basic_auth": {
          "properties": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "type": {
            "type": "object",
            "description": "deeply nested - truncated"
          }
        },
        "hmac": {
          "properties": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "type": {
            "type": "object",
            "description": "deeply nested - truncated"
          }
        },
        "type": {
          "enum": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "type": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "x-enum-varnames": {
            "type": "object",
            "description": "deeply nested - truncated"
          }
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}