Convoy · Schema

Convoy PortalLink

A scoped, embeddable customer-facing dashboard link granting access to a subset of endpoints.

WebhookWebhook GatewayEvent DeliveryEventingMessagingIntegrationAPI Infrastructure

Properties

Name	Type	Description
auth_key	string
auth_type	string
can_manage_endpoint	boolean
created_at	string
deleted_at	string
endpoint_count	integer
endpoints	array
endpoints_metadata	array
name	string
owner_id	string
project_id	string
token	string
uid	string
updated_at	string
url	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-portal-link-schema.json",
  "title": "Convoy PortalLink",
  "description": "A scoped, embeddable customer-facing dashboard link granting access to a subset of endpoints.",
  "properties": {
    "auth_key": {
      "type": "string"
    },
    "auth_type": {
      "enum": [
        "refresh_token",
        "static_token"
      ],
      "type": "string",
      "x-enum-varnames": [
        "PortalAuthTypeRefreshToken",
        "PortalAuthTypeStaticToken"
      ]
    },
    "can_manage_endpoint": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    },
    "deleted_at": {
      "type": "string"
    },
    "endpoint_count": {
      "type": "integer"
    },
    "endpoints": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "endpoints_metadata": {
      "items": {
        "properties": {
          "advanced_signatures": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "authentication": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "content_type": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "created_at": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "deleted_at": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "description": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "events": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "failure_rate": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "http_timeout": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "mtls_client_cert": {
            "allOf": {
              "type": "object",
              "description": "deeply nested - truncated"
            },
            "description": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "name": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "owner_id": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "project_id": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "rate_limit": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "rate_limit_duration": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "secrets": {
            "items": {
              "type": "object",
              "description": "deeply nested - truncated"
            },
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "slack_webhook_url": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "status": {
            "type": "object",
            "description": "deeply nested - truncated"
          },
          "support_email": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "uid": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "updated_at": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          },
          "url": {
            "type": {
              "type": "object",
              "description": "deeply nested - truncated"
            }
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "name": {
      "type": "string"
    },
    "owner_id": {
      "type": "string"
    },
    "project_id": {
      "type": "string"
    },
    "token": {
      "type": "string"
    },
    "uid": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "url": {
      "type": "string"
    }
  },
  "type": "object"
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema 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 Schema

curl "https://apis.io/api/v1/json-schemas/convoy-portal-link"

All schemas

curl "https://apis.io/api/v1/json-schemas?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.