Convoy · Example Payload

Convoy Subscription Example

WebhooksWebhook GatewayEvent DeliveryEventingMessagingIntegrationAPI Infrastructure

Convoy Subscription 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

uidnametypeendpoint_idsource_idfilter_configalert_configretry_configrate_limit_configcreated_atupdated_at

Example Payload

{
  "uid": "sub_01HZ4F0J0G3Y2QH9N5T7AZBQ72",
  "name": "Acme Production Invoice Events",
  "type": "outgoing",
  "endpoint_id": "01HZ4F0J0G3Y2QH9N5T7AZBQ6V",
  "source_id": "",
  "filter_config": {
    "event_types": [
      "invoice.paid",
      "invoice.failed",
      "invoice.created"
    ],
    "filter": {
      "headers": {},
      "body": {}
    }
  },
  "alert_config": {
    "count": 5,
    "threshold": "5m"
  },
  "retry_config": {
    "type": "exponential",
    "duration": "20s",
    "retry_count": 20
  },
  "rate_limit_config": {
    "count": 1000,
    "duration": 60
  },
  "created_at": "2026-04-12T15:30:00Z",
  "updated_at": "2026-05-01T09:00:00Z"
}