Svix · JSON Structure

Svix Endpoint Structure

Structural definition of the Svix Endpoint entity — a subscriber URL.

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

SvixEndpoint is a JSON Structure definition published by Svix.

Meta-schema:

JSON Structure

Raw ↑ 
{
  "name": "SvixEndpoint",
  "description": "Structural definition of the Svix Endpoint entity — a subscriber URL.",
  "fields": [
    { "name": "id", "type": "string", "required": true, "format": "ksuid", "prefix": "ep_" },
    { "name": "uid", "type": "string", "required": false },
    { "name": "url", "type": "uri", "required": true, "maxLength": 65536 },
    { "name": "description", "type": "string", "required": true },
    { "name": "disabled", "type": "boolean", "required": false, "default": false },
    { "name": "filterTypes", "type": "string[]", "required": false, "description": "Event types this endpoint subscribes to." },
    { "name": "channels", "type": "string[]", "required": false, "maxItems": 10 },
    { "name": "metadata", "type": "map<string,string>", "required": true },
    { "name": "throttleRate", "type": "integer", "required": false },
    { "name": "version", "type": "integer", "required": true, "deprecated": true },
    { "name": "createdAt", "type": "datetime", "required": true },
    { "name": "updatedAt", "type": "datetime", "required": true }
  ],
  "relations": [
    { "name": "application", "kind": "belongsTo", "target": "SvixApplication" },
    { "name": "attempts", "kind": "hasMany", "target": "SvixMessageAttempt" }
  ]
}