Convoy · Example Payload

Convoy Event Type Example

Emitted when an invoice transitions to the paid state.

WebhooksWebhook GatewayEvent DeliveryEventingMessagingIntegrationAPI Infrastructure

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

Top-level fields

uidnamedescriptioncategorydeprecated_atjson_schemacreated_atupdated_at

Example Payload

Raw ↑ 
{
  "uid": "et_01HZ4F0J0G3Y2QH9N5T7AZBQ77",
  "name": "invoice.paid",
  "description": "Emitted when an invoice transitions to the paid state.",
  "category": "billing",
  "deprecated_at": null,
  "json_schema": {
    "type": "object",
    "properties": {
      "invoice_id": {
        "type": "string"
      },
      "amount_cents": {
        "type": "integer"
      }
    },
    "required": [
      "invoice_id"
    ]
  },
  "created_at": "2026-04-10T12:00:00Z",
  "updated_at": "2026-04-10T12:00:00Z"
}