Svix · Example Payload

Svix Endpoint Create Example

Register a subscriber URL that will receive webhooks for an application, optionally filtered by event type and channel.

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

Svix Endpoint Create Example is an example object payload from Svix, with 5 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationsummarydescriptionrequestresponse

Example Payload

Raw ↑ 
{
  "operation": "POST /api/v1/app/{app_id}/endpoint",
  "summary": "Create Endpoint",
  "description": "Register a subscriber URL that will receive webhooks for an application, optionally filtered by event type and channel.",
  "request": {
    "method": "POST",
    "url": "https://api.us.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint",
    "headers": {
      "Authorization": "Bearer testsk_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "Content-Type": "application/json"
    },
    "body": {
      "url": "https://customer.example.com/webhooks/svix",
      "description": "Production webhook endpoint for Acme",
      "filterTypes": [
        "invoice.paid",
        "invoice.failed",
        "user.signup"
      ],
      "channels": [
        "project_123"
      ],
      "metadata": {
        "owner": "billing-team"
      }
    }
  },
  "response": {
    "status": 201,
    "body": {
      "id": "ep_2srOrx2ZWZBpBUvZwXKQmoEYga2",
      "url": "https://customer.example.com/webhooks/svix",
      "description": "Production webhook endpoint for Acme",
      "disabled": false,
      "filterTypes": [
        "invoice.paid",
        "invoice.failed",
        "user.signup"
      ],
      "channels": [
        "project_123"
      ],
      "metadata": {
        "owner": "billing-team"
      },
      "version": 1,
      "createdAt": "2026-05-22T15:31:00Z",
      "updatedAt": "2026-05-22T15:31:00Z"
    }
  }
}