Svix · JSON Structure

Svix Message Structure

Structural definition of the Svix Message — a webhook payload submitted by the platform user for fan-out delivery.

Type: Properties: 0
WebhooksWebhooks As A ServiceWebhook DeliveryWebhook SendingEvent DrivenEventingMessagingPub SubStreamingIngestIntegrationReliabilityRetriesDeliverabilitySigningVerificationHMACStandard WebhooksMulti TenantMulti RegionEnterpriseSaaSDeveloper PlatformAPIRESTSOC 2HIPAAPCI DSSGDPROpen SourceRustPolyglot SDKTerraformCLI

SvixMessage is a JSON Structure definition published by Svix.

Meta-schema:

JSON Structure

Raw ↑ 
{
  "name": "SvixMessage",
  "description": "Structural definition of the Svix Message — a webhook payload submitted by the platform user for fan-out delivery.",
  "fields": [
    { "name": "id", "type": "string", "required": true, "format": "ksuid", "prefix": "msg_" },
    { "name": "eventId", "type": "string", "required": false },
    { "name": "eventType", "type": "string", "required": true },
    { "name": "payload", "type": "object", "required": true },
    { "name": "channels", "type": "string[]", "required": false, "maxItems": 10 },
    { "name": "tags", "type": "string[]", "required": false, "maxItems": 5 },
    { "name": "deliverAt", "type": "datetime", "required": false },
    { "name": "timestamp", "type": "datetime", "required": true }
  ],
  "relations": [
    { "name": "application", "kind": "belongsTo", "target": "SvixApplication" },
    { "name": "attempts", "kind": "hasMany", "target": "SvixMessageAttempt" }
  ]
}