Convoy · Example Payload

Convoy Portal Link Example

WebhookWebhook GatewayEvent DeliveryEventingMessagingIntegrationAPI Infrastructure

Convoy Portal Link Example is an example object payload from Convoy, with 11 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

uidnameurltokenendpointsendpoint_countowner_idauth_keycan_manage_endpointcreated_atupdated_at

Example Payload

Raw ↑ 
{
  "uid": "pl_01HZ4F0J0G3Y2QH9N5T7AZBQ91",
  "name": "Acme Customer Portal",
  "url": "https://app.getconvoy.cloud/portal?token=tk_01HZ...redacted",
  "token": "tk_01HZ...redacted",
  "endpoints": [
    "01HZ4F0J0G3Y2QH9N5T7AZBQ6V"
  ],
  "endpoint_count": 1,
  "owner_id": "cust_acme_001",
  "auth_key": "",
  "can_manage_endpoint": true,
  "created_at": "2026-04-12T16:00:00Z",
  "updated_at": "2026-05-15T10:00:00Z"
}

Work with this as data

Every example 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 examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example 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 example 
curl "https://apis.io/api/v1/examples/convoy-portal-link-example"
All examples 
curl "https://apis.io/api/v1/examples?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.