Convoy · JSON Structure

Convoy Source Structure

An ingest source emitting events into Convoy.

Type: object Properties: 19

WebhookWebhook GatewayEvent DeliveryEventingMessagingIntegrationAPI Infrastructure

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

Properties

body_function created_at custom_response deleted_at forward_headers header_function idempotency_keys is_disabled mask_id name project_id provider provider_config pub_sub type uid updated_at url verifier

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

JSON Structure

{
  "$schema": "https://json-structure.org/draft/2024-01/structure",
  "$id": "https://api-evangelist.github.io/convoy/json-structure/convoy-source-structure.json",
  "title": "Convoy Source",
  "description": "An ingest source emitting events into Convoy.",
  "type": "object",
  "properties": {
    "body_function": {
      "description": "",
      "type": "string"
    },
    "created_at": {
      "description": "",
      "type": "string"
    },
    "custom_response": {
      "description": "",
      "type": "object"
    },
    "deleted_at": {
      "description": "",
      "type": "string"
    },
    "forward_headers": {
      "description": "",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "header_function": {
      "description": "",
      "type": "string"
    },
    "idempotency_keys": {
      "description": "",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "is_disabled": {
      "description": "",
      "type": "boolean"
    },
    "mask_id": {
      "description": "",
      "type": "string"
    },
    "name": {
      "description": "",
      "type": "string"
    },
    "project_id": {
      "description": "",
      "type": "string"
    },
    "provider": {
      "description": "",
      "type": "string",
      "enum": [
        {
          "type": "object"
        },
        {
          "type": "object"
        },
        {
          "type": "object"
        }
      ]
    },
    "provider_config": {
      "description": "",
      "type": "object"
    },
    "pub_sub": {
      "description": "",
      "type": "object"
    },
    "type": {
      "description": "",
      "type": "string",
      "enum": [
        {
          "type": "object"
        },
        {
          "type": "object"
        },
        {
          "type": "object"
        },
        {
          "type": "object"
        }
      ]
    },
    "uid": {
      "description": "",
      "type": "string"
    },
    "updated_at": {
      "description": "",
      "type": "string"
    },
    "url": {
      "description": "",
      "type": "string"
    },
    "verifier": {
      "description": "",
      "type": "object"
    }
  }
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this

find_json_structuresBrowse and filter every JSON Structure in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Structure

curl "https://apis.io/api/v1/json-structures/convoy-source-structure"

All json structure

curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.