Events · Example Payload

Events Event Source Descriptor Example

Emitted by order-service when a customer order is accepted into the OMS.

orderscommercekafkaproduction

Events Event Source Descriptor Example is an example object payload from Events, with 17 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idnamedescriptionbrokerprotocoltransportEndpointtopicOrChannelpartitionCountretentiondeliveryGuaranteeorderingScopecloudEventsSourcecloudEventsTypesschemaRegistryasyncApiownertags

Example Payload

events-event-source-descriptor-example.json Raw ↑
{
  "id": "orders.placed",
  "name": "Order Placed",
  "description": "Emitted by order-service when a customer order is accepted into the OMS.",
  "broker": "Apache Kafka",
  "protocol": "Kafka",
  "transportEndpoint": "kafka://kafka.svc.cluster.local:9092",
  "topicOrChannel": "orders.placed",
  "partitionCount": 12,
  "retention": {
    "duration": "P7D",
    "compaction": false
  },
  "deliveryGuarantee": "at-least-once",
  "orderingScope": "partition",
  "cloudEventsSource": "/services/order-service",
  "cloudEventsTypes": [
    "com.example.orders.placed.v1"
  ],
  "schemaRegistry": {
    "vendor": "Confluent Schema Registry",
    "url": "https://schema-registry.example.com",
    "subject": "orders.placed-value",
    "format": "Avro",
    "compatibility": "BACKWARD"
  },
  "asyncApi": "https://api.example.com/asyncapi/orders.yaml",
  "owner": {
    "team": "Commerce Platform",
    "email": "commerce-platform@example.com"
  },
  "tags": ["orders", "commerce", "kafka", "production"]
}

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/events-event-source-descriptor-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.

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