Skip to content

Instantly share code, notes, and snippets.

@0x7466

0x7466/svix-openapi.json

Created March 18, 2026 21:50
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save 0x7466/2e450e65ddc694e542ceb693c9c7ddc4 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save 0x7466/2e450e65ddc694e542ceb693c9c7ddc4 to your computer and use it in GitHub Desktop.
Download ZIP
Svix OpenAPI Spec
Raw
svix-openapi.json
This file has been truncated, but you can view the full file.
{
"openapi": "3.1.0",
"info": {
"title": "Svix API",
"description": "Welcome to the Svix API documentation!\n\nUseful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)\n\n# Introduction\n\nThis is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).\n\n## Main concepts\n\nIn Svix you have four important entities you will be interacting with:\n\n- `messages`: these are the webhooks being sent. They can have contents and a few other properties.\n- `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform.\n- `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type).\n- `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.\n\n\n## Authentication\n\nGet your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys).\n\n<SecurityDefinitions />\n\n\n## Code samples\n\nThe code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).\n\n\n## Idempotency\n\nSvix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.\n\nTo perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Your idempotency key should not begin with the string `auto_`, which is reserved for internal use by the client libraries.\n\nSvix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result for a period of up to 12 hours.\n\nPlease note that idempotency is only supported for `POST` requests.\n\n\n## Cross-Origin Resource Sharing\n\nThis API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.\n",
"version": "1.84.0",
"x-logo": {
"altText": "Svix Logo",
"url": "https://www.svix.com/static/img/brand-padded.svg"
}
},
"servers": [
{
"url": "https://api.eu.svix.com/",
"description": "The Svix EU region"
},
{
"url": "https://api.us.svix.com/",
"description": "The Svix US region"
},
{
"url": "https://api.ca.svix.com/",
"description": "The Svix Canada region"
},
{
"url": "https://api.au.svix.com/",
"description": "The Svix Australia region"
},
{
"url": "https://api.in.svix.com/",
"description": "The Svix India region"
}
],
"paths": {
"/api/v1/app": {
"get": {
"tags": [
"Application"
],
"summary": "List Applications",
"description": "List of all the organization's applications.",
"operationId": "v1.application.list",
"parameters": [
{
"in": "query",
"name": "exclude_apps_with_no_endpoints",
"description": "Exclude applications that have no endpoints. Default is false.",
"schema": {
"description": "Exclude applications that have no endpoints. Default is false.",
"default": false,
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "exclude_apps_with_disabled_endpoints",
"description": "Exclude applications that have only disabled endpoints. Default is false.",
"schema": {
"description": "Exclude applications that have only disabled endpoints. Default is false.",
"default": false,
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 31,
"minLength": 31,
"pattern": "^app_[A-Za-z0-9]{27}$",
"nullable": true,
"example": "app_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "form"
},
{
"in": "query",
"name": "order",
"description": "The sorting order of the returned items",
"schema": {
"description": "The sorting order of the returned items",
"$ref": "#/components/schemas/Ordering",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_ApplicationOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.application.list();"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.application.list();"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.application.list()"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.application.list()"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Application.List(ctx, nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.application.list()"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getApplication().list();"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.application.list"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.application().list(None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Application.List();"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->application->list();"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix application list"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"post": {
"tags": [
"Application"
],
"summary": "Create Application",
"description": "Create a new application.",
"operationId": "v1.application.create",
"parameters": [
{
"in": "query",
"name": "get_if_exists",
"description": "Get an existing application, or create a new one if doesn't exist. It's two separate functions in the libs.",
"schema": {
"description": "Get an existing application, or create a new one if doesn't exist. It's two separate functions in the libs.",
"default": false,
"type": "boolean"
},
"style": "form"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationOut"
}
}
}
},
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.application.create({\n name: \"My first application\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n metadata: {},\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.application.create({\n name: \"My first application\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n metadata: {},\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.application.create(\n ApplicationIn(\n name=\"My first application\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n metadata={},\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.application.create(\n ApplicationIn(\n name=\"My first application\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n metadata={},\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Application.Create(\n\tctx,\n\tApplicationIn{\n\t\tName: \"My first application\",\n\t\tRateLimit: ptr(uint16(1)),\n\t\tThrottleRate: ptr(uint16(1)),\n\t\tUid: ptr(\"unique-identifier\"),\n\t\tMetadata: nil,\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.application.create(\n ApplicationIn(\n name = \"My first application\",\n rateLimit = 1u,\n throttleRate = 1u,\n uid = \"unique-identifier\",\n metadata = mapOf(),\n )\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getApplication()\n .create(new ApplicationIn()\n .name(\"My first application\")\n .rateLimit(1L)\n .throttleRate(1L)\n .uid(\"unique-identifier\")\n .metadata(Map.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .application\n .create({name: \"My first application\", rateLimit: 1, throttleRate: 1, uid: \"unique-identifier\", metadata: {}})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .application()\n .create(\n ApplicationIn {\n name: \"My first application\".to_string(),\n rate_limit: Some(1),\n throttle_rate: Some(1),\n uid: Some(\"unique-identifier\".to_string()),\n metadata: Some(HashMap::new()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Application.Create(\n new ApplicationIn\n {\n Name = \"My first application\",\n RateLimit = 1,\n ThrottleRate = 1,\n Uid = \"unique-identifier\",\n Metadata = [],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->application->create(\n ApplicationIn::create(\n name: \"My first application\"\n )\n ->withRateLimit(1)\n ->withThrottleRate(1)\n ->withUid(\"unique-identifier\")\n ->withMetadata([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix application create '{\n \"metadata\": {},\n \"name\": \"My first application\",\n \"rateLimit\": 1,\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"metadata\": {},\n \"name\": \"My first application\",\n \"rateLimit\": 1,\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\"\n }'"
}
]
}
},
"/api/v1/app/{app_id}": {
"get": {
"tags": [
"Application"
],
"summary": "Get Application",
"description": "Get an application.",
"operationId": "v1.application.get",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.application.get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.application.get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.application.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.application.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Application.Get(ctx, \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.application.get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getApplication().get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.application.get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .application()\n .get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string())\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Application.Get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->application->get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix application get \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"put": {
"tags": [
"Application"
],
"summary": "Update Application",
"description": "Update an application.",
"operationId": "v1.application.update",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationOut"
}
}
}
},
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.application.update(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n name: \"My first application\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n metadata: {},\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.application.update(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n name: \"My first application\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n metadata: {},\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.application.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n ApplicationIn(\n name=\"My first application\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n metadata={},\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.application.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n ApplicationIn(\n name=\"My first application\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n metadata={},\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Application.Update(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\tApplicationIn{\n\t\tName: \"My first application\",\n\t\tRateLimit: ptr(uint16(1)),\n\t\tThrottleRate: ptr(uint16(1)),\n\t\tUid: ptr(\"unique-identifier\"),\n\t\tMetadata: nil,\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.application.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n ApplicationIn(\n name = \"My first application\",\n rateLimit = 1u,\n throttleRate = 1u,\n uid = \"unique-identifier\",\n metadata = mapOf(),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getApplication()\n .update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new ApplicationIn()\n .name(\"My first application\")\n .rateLimit(1L)\n .throttleRate(1L)\n .uid(\"unique-identifier\")\n .metadata(Map.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .application\n .update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n {name: \"My first application\", rateLimit: 1, throttleRate: 1, uid: \"unique-identifier\", metadata: {}}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .application()\n .update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n ApplicationIn {\n name: \"My first application\".to_string(),\n rate_limit: Some(1),\n throttle_rate: Some(1),\n uid: Some(\"unique-identifier\".to_string()),\n metadata: Some(HashMap::new()),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Application.Update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new ApplicationIn\n {\n Name = \"My first application\",\n RateLimit = 1,\n ThrottleRate = 1,\n Uid = \"unique-identifier\",\n Metadata = [],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->application->update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n ApplicationIn::create(\n name: \"My first application\"\n )\n ->withRateLimit(1)\n ->withThrottleRate(1)\n ->withUid(\"unique-identifier\")\n ->withMetadata([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix application update \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" '{\n \"metadata\": {},\n \"name\": \"My first application\",\n \"rateLimit\": 1,\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PUT' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"metadata\": {},\n \"name\": \"My first application\",\n \"rateLimit\": 1,\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\"\n }'"
}
]
},
"delete": {
"tags": [
"Application"
],
"summary": "Delete Application",
"description": "Delete an application.",
"operationId": "v1.application.delete",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.application.delete(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.application.delete(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.application.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.application.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Application.Delete(ctx, \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.application.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getApplication().delete(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.application.delete(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.application().delete(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string()).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Application.Delete(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->application->delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix application delete \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'DELETE' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
},
"patch": {
"tags": [
"Application"
],
"summary": "Patch Application",
"description": "Partially update an application.",
"operationId": "v1.application.patch",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.application.patch(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n name: \"sample string\",\n rateLimit: 1,\n uid: \"unique-identifier\",\n metadata: {},\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.application.patch(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n name: \"sample string\",\n rateLimit: 1,\n uid: \"unique-identifier\",\n metadata: {},\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.application.patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n ApplicationPatch(\n name=\"sample string\",\n rate_limit=1,\n uid=\"unique-identifier\",\n metadata={},\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.application.patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n ApplicationPatch(\n name=\"sample string\",\n rate_limit=1,\n uid=\"unique-identifier\",\n metadata={},\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Application.Patch(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\tApplicationPatch{\n\t\tName: ptr(\"sample string\"),\n\t\tRateLimit: NewNullable(uint16(1)),\n\t\tUid: NewNullable(\"unique-identifier\"),\n\t\tMetadata: nil,\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.application.patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n ApplicationPatch(\n name = \"sample string\",\n rateLimit = MaybeUnset.Present(1u),\n uid = MaybeUnset.Present(\"unique-identifier\"),\n metadata = mapOf(),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getApplication()\n .patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new ApplicationPatch()\n .name(\"sample string\")\n .rateLimit(1L)\n .uid(\"unique-identifier\")\n .metadata(Map.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .application\n .patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n {name: \"sample string\", rateLimit: 1, uid: \"unique-identifier\", metadata: {}}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .application()\n .patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n ApplicationPatch {\n name: Some(\"sample string\".to_string()),\n rate_limit: js_option::JsOption::Some(1),\n uid: js_option::JsOption::Some(\"unique-identifier\".to_string()),\n metadata: Some(HashMap::new()),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Application.Patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new ApplicationPatch\n {\n Name = \"sample string\",\n RateLimit = 1,\n Uid = \"unique-identifier\",\n Metadata = [],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->application->patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n ApplicationPatch::create()\n ->withName(\"sample string\")\n ->withRateLimit(1)\n ->withUid(\"unique-identifier\")\n ->withMetadata([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix application patch \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" '{\n \"metadata\": {},\n \"name\": \"sample string\",\n \"rateLimit\": 1,\n \"uid\": \"unique-identifier\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PATCH' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"metadata\": {},\n \"name\": \"sample string\",\n \"rateLimit\": 1,\n \"uid\": \"unique-identifier\"\n }'"
}
]
}
},
"/api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}": {
"get": {
"tags": [
"Message Attempt"
],
"summary": "List Attempts By Endpoint",
"description": "List attempts by endpoint id\n\nNote that by default this endpoint is limited to retrieving 90 days' worth of data\nrelative to now or, if an iterator is provided, 90 days before/after the time indicated\nby the iterator ID. If you require data beyond those time ranges, you will need to explicitly\nset the `before` or `after` parameter as appropriate.\n",
"operationId": "v1.message-attempt.list-by-endpoint",
"parameters": [
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 33,
"minLength": 33,
"pattern": "^atmpt_[A-Za-z0-9]{27}$",
"nullable": true,
"example": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "form"
},
{
"in": "query",
"name": "status",
"description": "Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), or Sending (3)",
"schema": {
"description": "Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), or Sending (3)",
"$ref": "#/components/schemas/MessageStatus",
"nullable": true
},
"explode": false,
"style": "form"
},
{
"in": "query",
"name": "status_code_class",
"description": "Filter response based on the HTTP status code",
"schema": {
"description": "Filter response based on the HTTP status code",
"$ref": "#/components/schemas/StatusCodeClass",
"nullable": true
},
"explode": false,
"style": "form"
},
{
"in": "query",
"name": "channel",
"description": "Filter response based on the channel",
"schema": {
"description": "Filter response based on the channel",
"type": "string",
"maxLength": 128,
"pattern": "^[a-zA-Z0-9\\-_.:]+$",
"nullable": true,
"example": "project_1337"
},
"style": "form"
},
{
"in": "query",
"name": "tag",
"description": "Filter response based on the tag",
"schema": {
"description": "Filter response based on the tag",
"type": "string",
"maxLength": 128,
"pattern": "^[a-zA-Z0-9\\-_./\\\\#]+$",
"nullable": true,
"example": "project_1337"
},
"style": "form"
},
{
"in": "query",
"name": "before",
"description": "Only include items created before a certain date",
"schema": {
"description": "Only include items created before a certain date",
"type": "string",
"format": "date-time",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "after",
"description": "Only include items created after a certain date",
"schema": {
"description": "Only include items created after a certain date",
"type": "string",
"format": "date-time",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "with_content",
"description": "When `true` attempt content is included in the response",
"schema": {
"description": "When `true` attempt content is included in the response",
"default": true,
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "with_msg",
"description": "When `true`, the message information is included in the response",
"schema": {
"description": "When `true`, the message information is included in the response",
"default": false,
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "event_types",
"description": "Filter response based on the event type",
"schema": {
"description": "Filter response based on the event type",
"type": "array",
"items": {
"description": "The event type's name",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "user.signup"
},
"uniqueItems": true,
"nullable": true
},
"style": "form"
},
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_MessageAttemptOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.messageAttempt.listByEndpoint(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.messageAttempt.listByEndpoint(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message_attempt.list_by_endpoint(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message_attempt.list_by_endpoint(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.MessageAttempt.ListByEndpoint(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.messageAttempt.listByEndpoint(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessageAttempt()\n .listByEndpoint(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.message_attempt.list_by_endpoint(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message_attempt()\n .list_by_endpoint(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.MessageAttempt.ListByEndpoint(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->messageAttempt->listByEndpoint(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message-attempt list-by-endpoint \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/attempt/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/attempt/msg/{msg_id}": {
"get": {
"tags": [
"Message Attempt"
],
"summary": "List Attempts By Msg",
"description": "List attempts by message ID.\n\nNote that by default this endpoint is limited to retrieving 90 days' worth of data\nrelative to now or, if an iterator is provided, 90 days before/after the time indicated\nby the iterator ID. If you require data beyond those time ranges, you will need to explicitly\nset the `before` or `after` parameter as appropriate.",
"operationId": "v1.message-attempt.list-by-msg",
"parameters": [
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 33,
"minLength": 33,
"pattern": "^atmpt_[A-Za-z0-9]{27}$",
"nullable": true,
"example": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "form"
},
{
"in": "query",
"name": "status",
"description": "Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), or Sending (3)",
"schema": {
"description": "Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), or Sending (3)",
"$ref": "#/components/schemas/MessageStatus",
"nullable": true
},
"explode": false,
"style": "form"
},
{
"in": "query",
"name": "status_code_class",
"description": "Filter response based on the HTTP status code",
"schema": {
"description": "Filter response based on the HTTP status code",
"$ref": "#/components/schemas/StatusCodeClass",
"nullable": true
},
"explode": false,
"style": "form"
},
{
"in": "query",
"name": "channel",
"description": "Filter response based on the channel",
"schema": {
"description": "Filter response based on the channel",
"type": "string",
"maxLength": 128,
"pattern": "^[a-zA-Z0-9\\-_.:]+$",
"nullable": true,
"example": "project_1337"
},
"style": "form"
},
{
"in": "query",
"name": "tag",
"description": "Filter response based on the tag",
"schema": {
"description": "Filter response based on the tag",
"type": "string",
"maxLength": 128,
"pattern": "^[a-zA-Z0-9\\-_./\\\\#]+$",
"nullable": true,
"example": "project_1337"
},
"style": "form"
},
{
"in": "query",
"name": "endpoint_id",
"description": "Filter the attempts based on the attempted endpoint",
"schema": {
"description": "Filter the attempts based on the attempted endpoint",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"nullable": true,
"example": "unique-identifier"
},
"style": "form"
},
{
"in": "query",
"name": "before",
"description": "Only include items created before a certain date",
"schema": {
"description": "Only include items created before a certain date",
"type": "string",
"format": "date-time",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "after",
"description": "Only include items created after a certain date",
"schema": {
"description": "Only include items created after a certain date",
"type": "string",
"format": "date-time",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "with_content",
"description": "When `true` attempt content is included in the response",
"schema": {
"description": "When `true` attempt content is included in the response",
"default": true,
"type": "boolean"
},
"style": "form"
},
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "msg_id",
"description": "The Message's ID or UID.",
"required": true,
"schema": {
"description": "The Message's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "query",
"name": "event_types",
"description": "Filter response based on the event type",
"schema": {
"description": "Filter response based on the event type",
"type": "array",
"items": {
"description": "The event type's name",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "user.signup"
},
"uniqueItems": true,
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_MessageAttemptOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.messageAttempt.listByMsg(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.messageAttempt.listByMsg(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message_attempt.list_by_msg(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message_attempt.list_by_msg(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.MessageAttempt.ListByMsg(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.messageAttempt.listByMsg(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessageAttempt()\n .listByMsg(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.message_attempt.list_by_msg(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message_attempt()\n .list_by_msg(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\".to_string(),\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.MessageAttempt.ListByMsg(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->messageAttempt->listByMsg(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message-attempt list-by-msg \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/attempt/msg/msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/endpoint": {
"get": {
"tags": [
"Endpoint"
],
"summary": "List Endpoints",
"description": "List the application's endpoints.",
"operationId": "v1.endpoint.list",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 30,
"minLength": 30,
"pattern": "^ep_[A-Za-z0-9]{27}$",
"nullable": true,
"example": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "form"
},
{
"in": "query",
"name": "order",
"description": "The sorting order of the returned items",
"schema": {
"description": "The sorting order of the returned items",
"$ref": "#/components/schemas/Ordering",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_EndpointOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.list(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.list(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.List(ctx, \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.endpoint.list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEndpoint().list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.endpoint.list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(), None)\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.List(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->list(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint list \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"post": {
"tags": [
"Endpoint"
],
"summary": "Create Endpoint",
"description": "Create a new endpoint for the application.\n\nWhen `secret` is `null` the secret is automatically generated (recommended).",
"operationId": "v1.endpoint.create",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointIn"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.create(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n description: \"An example endpoint name\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n headers: { \"X-Example\": \"123\", \"X-Foobar\": \"Bar\" },\n disabled: true,\n filterTypes: [\"user.signup\", \"user.deleted\"],\n channels: [\"project_123\", \"group_2\"],\n secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n metadata: {},\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.create(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n description: \"An example endpoint name\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n headers: { \"X-Example\": \"123\", \"X-Foobar\": \"Bar\" },\n disabled: true,\n filterTypes: [\"user.signup\", \"user.deleted\"],\n channels: [\"project_123\", \"group_2\"],\n secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n metadata: {},\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n EndpointIn(\n description=\"An example endpoint name\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n url=\"https://example.com/webhook/\",\n headers={\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n disabled=True,\n filter_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n channels=[\n \"project_123\",\n \"group_2\",\n ],\n secret=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n metadata={},\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n EndpointIn(\n description=\"An example endpoint name\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n url=\"https://example.com/webhook/\",\n headers={\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n disabled=True,\n filter_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n channels=[\n \"project_123\",\n \"group_2\",\n ],\n secret=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n metadata={},\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.Create(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\tEndpointIn{\n\t\tDescription: ptr(\"An example endpoint name\"),\n\t\tRateLimit: ptr(uint16(1)),\n\t\tThrottleRate: ptr(uint16(1)),\n\t\tUid: ptr(\"unique-identifier\"),\n\t\tUrl: \"https://example.com/webhook/\",\n\t\tHeaders: &map[string]string{\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n\t\tDisabled: ptr(true),\n\t\tFilterTypes: []string{\"user.signup\", \"user.deleted\"},\n\t\tChannels: []string{\"project_123\", \"group_2\"},\n\t\tSecret: ptr(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"),\n\t\tMetadata: nil,\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.endpoint.create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n EndpointIn(\n description = \"An example endpoint name\",\n rateLimit = 1u,\n throttleRate = 1u,\n uid = \"unique-identifier\",\n url = \"https://example.com/webhook/\",\n headers = mapOf(\"X-Example\" to \"123\", \"X-Foobar\" to \"Bar\"),\n disabled = true,\n filterTypes = setOf(\"user.signup\", \"user.deleted\"),\n channels = setOf(\"project_123\", \"group_2\"),\n secret = \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n metadata = mapOf(),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEndpoint()\n .create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new EndpointIn()\n .description(\"An example endpoint name\")\n .rateLimit(1L)\n .throttleRate(1L)\n .uid(\"unique-identifier\")\n .url(URI.create(\"https://example.com/webhook/\"))\n .headers(Map.ofEntries(Map.entry(\"X-Example\", \"123\"), Map.entry(\"X-Foobar\", \"Bar\")))\n .disabled(true)\n .filterTypes(Set.of(\"user.signup\", \"user.deleted\"))\n .channels(Set.of(\"project_123\", \"group_2\"))\n .secret(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")\n .metadata(Map.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .endpoint\n .create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n {\n description: \"An example endpoint name\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n headers: {:\"X-Example\" => \"123\", :\"X-Foobar\" => \"Bar\"},\n disabled: true,\n filterTypes: [\"user.signup\", \"user.deleted\"],\n channels: [\"project_123\", \"group_2\"],\n secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n metadata: {}\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n EndpointIn {\n description: Some(\"An example endpoint name\".to_string()),\n rate_limit: Some(1),\n throttle_rate: Some(1),\n uid: Some(\"unique-identifier\".to_string()),\n url: \"https://example.com/webhook/\".to_string(),\n headers: Some(\n HashMap::from([\n (\"X-Example\".to_string(), \"123\".to_string()),\n (\"X-Foobar\".to_string(), \"Bar\".to_string()),\n ]),\n ),\n disabled: Some(true),\n filter_types: Some(\n vec![\"user.signup\".to_string(), \"user.deleted\".to_string()],\n ),\n channels: Some(vec![\"project_123\".to_string(), \"group_2\".to_string()]),\n secret: Some(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\".to_string()),\n metadata: Some(HashMap::new()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.Create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new EndpointIn\n {\n Description = \"An example endpoint name\",\n RateLimit = 1,\n ThrottleRate = 1,\n Uid = \"unique-identifier\",\n Url = \"https://example.com/webhook/\",\n Headers = new() { { \"X-Example\", \"123\" }, { \"X-Foobar\", \"Bar\" } },\n Disabled = true,\n FilterTypes = [\"user.signup\", \"user.deleted\"],\n Channels = [\"project_123\", \"group_2\"],\n Secret = \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n Metadata = [],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n EndpointIn::create(\n url: \"https://example.com/webhook/\"\n )\n ->withDescription(\"An example endpoint name\")\n ->withRateLimit(1)\n ->withThrottleRate(1)\n ->withUid(\"unique-identifier\")\n ->withHeaders([\"X-Example\" => \"123\", \"X-Foobar\" => \"Bar\"])\n ->withDisabled(true)\n ->withFilterTypes([\"user.signup\",\"user.deleted\"])\n ->withChannels([\"project_123\",\"group_2\"])\n ->withSecret(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")\n ->withMetadata([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint create \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" '{\n \"channels\": [\n \"project_123\",\n \"group_2\"\n ],\n \"description\": \"An example endpoint name\",\n \"disabled\": true,\n \"filterTypes\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"headers\": {\n \"X-Example\": \"123\",\n \"X-Foobar\": \"Bar\"\n },\n \"metadata\": {},\n \"rateLimit\": 1,\n \"secret\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\",\n \"url\": \"https://example.com/webhook/\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"channels\": [\n \"project_123\",\n \"group_2\"\n ],\n \"description\": \"An example endpoint name\",\n \"disabled\": true,\n \"filterTypes\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"headers\": {\n \"X-Example\": \"123\",\n \"X-Foobar\": \"Bar\"\n },\n \"metadata\": {},\n \"rateLimit\": 1,\n \"secret\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\",\n \"url\": \"https://example.com/webhook/\"\n }'"
}
]
}
},
"/api/v1/app/{app_id}/endpoint/{endpoint_id}": {
"get": {
"tags": [
"Endpoint"
],
"summary": "Get Endpoint",
"description": "Get an endpoint.",
"operationId": "v1.endpoint.get",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.Get(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.endpoint.get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response =\n svix.getEndpoint().get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.endpoint.get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.Get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint get \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"put": {
"tags": [
"Endpoint"
],
"summary": "Update Endpoint",
"description": "Update an endpoint.",
"operationId": "v1.endpoint.update",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointOut"
}
}
}
},
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n description: \"An example endpoint name\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n metadata: {},\n disabled: true,\n filterTypes: [\"user.signup\", \"user.deleted\"],\n channels: [\"project_123\", \"group_2\"],\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n description: \"An example endpoint name\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n metadata: {},\n disabled: true,\n filterTypes: [\"user.signup\", \"user.deleted\"],\n channels: [\"project_123\", \"group_2\"],\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointUpdate(\n description=\"An example endpoint name\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n url=\"https://example.com/webhook/\",\n metadata={},\n disabled=True,\n filter_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n channels=[\n \"project_123\",\n \"group_2\",\n ],\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointUpdate(\n description=\"An example endpoint name\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n url=\"https://example.com/webhook/\",\n metadata={},\n disabled=True,\n filter_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n channels=[\n \"project_123\",\n \"group_2\",\n ],\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.Update(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tEndpointUpdate{\n\t\tDescription: ptr(\"An example endpoint name\"),\n\t\tRateLimit: ptr(uint16(1)),\n\t\tThrottleRate: ptr(uint16(1)),\n\t\tUid: ptr(\"unique-identifier\"),\n\t\tUrl: \"https://example.com/webhook/\",\n\t\tMetadata: nil,\n\t\tDisabled: ptr(true),\n\t\tFilterTypes: []string{\"user.signup\", \"user.deleted\"},\n\t\tChannels: []string{\"project_123\", \"group_2\"},\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.endpoint.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointUpdate(\n description = \"An example endpoint name\",\n rateLimit = 1u,\n throttleRate = 1u,\n uid = \"unique-identifier\",\n url = \"https://example.com/webhook/\",\n metadata = mapOf(),\n disabled = true,\n filterTypes = setOf(\"user.signup\", \"user.deleted\"),\n channels = setOf(\"project_123\", \"group_2\"),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEndpoint()\n .update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointUpdate()\n .description(\"An example endpoint name\")\n .rateLimit(1L)\n .throttleRate(1L)\n .uid(\"unique-identifier\")\n .url(URI.create(\"https://example.com/webhook/\"))\n .metadata(Map.of())\n .disabled(true)\n .filterTypes(Set.of(\"user.signup\", \"user.deleted\"))\n .channels(Set.of(\"project_123\", \"group_2\")));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .endpoint\n .update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n description: \"An example endpoint name\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n metadata: {},\n disabled: true,\n filterTypes: [\"user.signup\", \"user.deleted\"],\n channels: [\"project_123\", \"group_2\"]\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n EndpointUpdate {\n description: Some(\"An example endpoint name\".to_string()),\n rate_limit: Some(1),\n throttle_rate: Some(1),\n uid: Some(\"unique-identifier\".to_string()),\n url: \"https://example.com/webhook/\".to_string(),\n metadata: Some(HashMap::new()),\n disabled: Some(true),\n filter_types: Some(\n vec![\"user.signup\".to_string(), \"user.deleted\".to_string()],\n ),\n channels: Some(vec![\"project_123\".to_string(), \"group_2\".to_string()]),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.Update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointUpdate\n {\n Description = \"An example endpoint name\",\n RateLimit = 1,\n ThrottleRate = 1,\n Uid = \"unique-identifier\",\n Url = \"https://example.com/webhook/\",\n Metadata = [],\n Disabled = true,\n FilterTypes = [\"user.signup\", \"user.deleted\"],\n Channels = [\"project_123\", \"group_2\"],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointUpdate::create(\n url: \"https://example.com/webhook/\"\n )\n ->withDescription(\"An example endpoint name\")\n ->withRateLimit(1)\n ->withThrottleRate(1)\n ->withUid(\"unique-identifier\")\n ->withMetadata([])\n ->withDisabled(true)\n ->withFilterTypes([\"user.signup\",\"user.deleted\"])\n ->withChannels([\"project_123\",\"group_2\"])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint update \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"channels\": [\n \"project_123\",\n \"group_2\"\n ],\n \"description\": \"An example endpoint name\",\n \"disabled\": true,\n \"filterTypes\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"metadata\": {},\n \"rateLimit\": 1,\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\",\n \"url\": \"https://example.com/webhook/\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PUT' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"channels\": [\n \"project_123\",\n \"group_2\"\n ],\n \"description\": \"An example endpoint name\",\n \"disabled\": true,\n \"filterTypes\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"metadata\": {},\n \"rateLimit\": 1,\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\",\n \"url\": \"https://example.com/webhook/\"\n }'"
}
]
},
"delete": {
"tags": [
"Endpoint"
],
"summary": "Delete Endpoint",
"description": "Delete an endpoint.",
"operationId": "v1.endpoint.delete",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.endpoint.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.endpoint.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.endpoint.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.endpoint.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Endpoint.Delete(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.endpoint.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getEndpoint().delete(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.endpoint.delete(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.endpoint()\n .delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.Delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->endpoint->delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint delete \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'DELETE' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
},
"patch": {
"tags": [
"Endpoint"
],
"summary": "Patch Endpoint",
"description": "Partially update an endpoint.",
"operationId": "v1.endpoint.patch",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n description: \"sample string\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"sample string\",\n metadata: {},\n disabled: true,\n filterTypes: [],\n channels: [],\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n description: \"sample string\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"sample string\",\n metadata: {},\n disabled: true,\n filterTypes: [],\n channels: [],\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointPatch(\n description=\"sample string\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n url=\"sample string\",\n metadata={},\n disabled=True,\n filter_types=[],\n channels=[],\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointPatch(\n description=\"sample string\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n url=\"sample string\",\n metadata={},\n disabled=True,\n filter_types=[],\n channels=[],\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.Patch(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tEndpointPatch{\n\t\tDescription: ptr(\"sample string\"),\n\t\tRateLimit: NewNullable(uint16(1)),\n\t\tThrottleRate: NewNullable(uint16(1)),\n\t\tUid: NewNullable(\"unique-identifier\"),\n\t\tUrl: ptr(\"sample string\"),\n\t\tMetadata: nil,\n\t\tDisabled: ptr(true),\n\t\tFilterTypes: NewNullable([]string{}),\n\t\tChannels: NewNullable([]string{}),\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.endpoint.patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointPatch(\n description = \"sample string\",\n rateLimit = MaybeUnset.Present(1u),\n throttleRate = MaybeUnset.Present(1u),\n uid = MaybeUnset.Present(\"unique-identifier\"),\n url = \"https://example.com/\",\n metadata = mapOf(),\n disabled = true,\n filterTypes = MaybeUnset.Present(setOf()),\n channels = MaybeUnset.Present(setOf()),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEndpoint()\n .patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointPatch()\n .description(\"sample string\")\n .rateLimit(1L)\n .throttleRate(1L)\n .uid(\"unique-identifier\")\n .url(URI.create(\"https://example.com/\"))\n .metadata(Map.of())\n .disabled(true)\n .filterTypes(Set.of())\n .channels(Set.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .endpoint\n .patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n description: \"sample string\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"sample string\",\n metadata: {},\n disabled: true,\n filterTypes: [],\n channels: []\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n EndpointPatch {\n description: Some(\"sample string\".to_string()),\n rate_limit: js_option::JsOption::Some(1),\n throttle_rate: js_option::JsOption::Some(1),\n uid: js_option::JsOption::Some(\"unique-identifier\".to_string()),\n url: Some(\"sample string\".to_string()),\n metadata: Some(HashMap::new()),\n disabled: Some(true),\n filter_types: js_option::JsOption::Some(vec![]),\n channels: js_option::JsOption::Some(vec![]),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.Patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointPatch\n {\n Description = \"sample string\",\n RateLimit = 1,\n ThrottleRate = 1,\n Uid = \"unique-identifier\",\n Url = \"sample string\",\n Metadata = [],\n Disabled = true,\n FilterTypes = MaybeUnset<List<string>?>.Set([]),\n Channels = MaybeUnset<List<string>?>.Set([]),\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->patch(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointPatch::create()\n ->withDescription(\"sample string\")\n ->withRateLimit(1)\n ->withThrottleRate(1)\n ->withUid(\"unique-identifier\")\n ->withUrl(\"sample string\")\n ->withMetadata([])\n ->withDisabled(true)\n ->withFilterTypes([])\n ->withChannels([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint patch \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"channels\": [],\n \"description\": \"sample string\",\n \"disabled\": true,\n \"filterTypes\": [],\n \"metadata\": {},\n \"rateLimit\": 1,\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\",\n \"url\": \"sample string\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PATCH' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"channels\": [],\n \"description\": \"sample string\",\n \"disabled\": true,\n \"filterTypes\": [],\n \"metadata\": {},\n \"rateLimit\": 1,\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\",\n \"url\": \"sample string\"\n }'"
}
]
}
},
"/api/v1/app/{app_id}/endpoint/{endpoint_id}/bulk-replay": {
"post": {
"tags": [
"Endpoint"
],
"summary": "Bulk Replay Messages",
"description": "Bulk replay messages sent to the endpoint.\n\nOnly messages that were created after `since` will be sent.\nThis will replay both successful, and failed messages\n\nA completed task will return a payload like the following:\n```json\n{\n \"id\": \"qtask_33qen93MNuelBAq1T9G7eHLJRsF\",\n \"status\": \"finished\",\n \"task\": \"endpoint.bulk-replay\",\n \"data\": {\n \"messagesSent\": 2\n }\n}\n```",
"operationId": "v1.endpoint.bulk-replay",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkReplayIn"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReplayOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.bulkReplay(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n since: new Date(\"2025-10-02T20:28:42+00:00\"),\n until: new Date(\"2025-10-02T20:28:42+00:00\"),\n eventTypes: [],\n channel: \"project_1337\",\n tag: \"project_1337\",\n status: MessageStatus.Success,\n statusCodeClass: StatusCodeClass.CodeNone,\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.bulkReplay(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n since: new Date(\"2025-10-02T20:28:42+00:00\"),\n until: new Date(\"2025-10-02T20:28:42+00:00\"),\n eventTypes: [],\n channel: \"project_1337\",\n tag: \"project_1337\",\n status: MessageStatus.Success,\n statusCodeClass: StatusCodeClass.CodeNone,\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.bulk_replay(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n BulkReplayIn(\n since=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n until=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n event_types=[],\n channel=\"project_1337\",\n tag=\"project_1337\",\n status=MessageStatus.SUCCESS,\n status_code_class=StatusCodeClass.CODE_NONE,\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.bulk_replay(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n BulkReplayIn(\n since=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n until=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n event_types=[],\n channel=\"project_1337\",\n tag=\"project_1337\",\n status=MessageStatus.SUCCESS,\n status_code_class=StatusCodeClass.CODE_NONE,\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.BulkReplay(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tBulkReplayIn{\n\t\tSince: time.Date(2025, 10, 2, 20, 28, 42, 0, time.UTC),\n\t\tUntil: ptr(time.Date(2025, 10, 2, 20, 28, 42, 0, time.UTC)),\n\t\tEventTypes: []string{},\n\t\tChannel: ptr(\"project_1337\"),\n\t\tTag: ptr(\"project_1337\"),\n\t\tStatus: ptr(MESSAGESTATUS_SUCCESS),\n\t\tStatusCodeClass: ptr(STATUSCODECLASS_CODE_NONE),\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.endpoint.bulkReplay(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n BulkReplayIn(\n since = Instant.parse(\"2025-10-02T20:28:42+00:00\"),\n until = Instant.parse(\"2025-10-02T20:28:42+00:00\"),\n eventTypes = setOf(),\n channel = \"project_1337\",\n tag = \"project_1337\",\n status = MessageStatus.SUCCESS,\n statusCodeClass = StatusCodeClass.CODE_NONE,\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEndpoint()\n .bulkReplay(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new BulkReplayIn()\n .since(OffsetDateTime.parse(\"2025-10-02T20:28:42+00:00\"))\n .until(OffsetDateTime.parse(\"2025-10-02T20:28:42+00:00\"))\n .eventTypes(Set.of())\n .channel(\"project_1337\")\n .tag(\"project_1337\")\n .status(MessageStatus.SUCCESS)\n .statusCodeClass(StatusCodeClass.CODE_NONE));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .endpoint\n .bulk_replay(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n since: \"2025-10-02T20:28:42+00:00\",\n until: \"2025-10-02T20:28:42+00:00\",\n eventTypes: [],\n channel: \"project_1337\",\n tag: \"project_1337\",\n status: MessageStatus::SUCCESS,\n statusCodeClass: StatusCodeClass::CODE_NONE\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .bulk_replay(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n BulkReplayIn {\n since: \"2025-10-02T20:28:42+00:00\".to_string(),\n until: Some(\"2025-10-02T20:28:42+00:00\".to_string()),\n event_types: Some(vec![]),\n channel: Some(\"project_1337\".to_string()),\n tag: Some(\"project_1337\".to_string()),\n status: Some(MessageStatus::Success),\n status_code_class: Some(StatusCodeClass::CodeNone),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.BulkReplay(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new BulkReplayIn\n {\n Since = DateTime.Parse(\"2025-10-02T20:28:42+00:00\"),\n Until = DateTime.Parse(\"2025-10-02T20:28:42+00:00\"),\n EventTypes = [],\n Channel = \"project_1337\",\n Tag = \"project_1337\",\n Status = MessageStatus.Success,\n StatusCodeClass = StatusCodeClass.CodeNone,\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->bulkReplay(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n BulkReplayIn::create(\n since: new DateTimeImmutable(\"2025-10-02T20:28:42+00:00\")\n )\n ->withUntil(new DateTimeImmutable(\"2025-10-02T20:28:42+00:00\"))\n ->withEventTypes([])\n ->withChannel(\"project_1337\")\n ->withTag(\"project_1337\")\n ->withStatus(MessageStatus::SUCCESS)\n ->withStatusCodeClass(StatusCodeClass::CODE_NONE)\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint bulk-replay \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"channel\": \"project_1337\",\n \"eventTypes\": [],\n \"since\": \"2025-10-02T20:28:42+00:00\",\n \"status\": 0,\n \"statusCodeClass\": 0,\n \"tag\": \"project_1337\",\n \"until\": \"2025-10-02T20:28:42+00:00\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/bulk-replay' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"channel\": \"project_1337\",\n \"eventTypes\": [],\n \"since\": \"2025-10-02T20:28:42+00:00\",\n \"status\": 0,\n \"statusCodeClass\": 0,\n \"tag\": \"project_1337\",\n \"until\": \"2025-10-02T20:28:42+00:00\"\n }'"
}
]
}
},
"/api/v1/app/{app_id}/endpoint/{endpoint_id}/headers": {
"get": {
"tags": [
"Endpoint"
],
"summary": "Get Endpoint Headers",
"description": "Get the additional headers to be sent with the webhook.",
"operationId": "v1.endpoint.get-headers",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "The value of the headers is returned in the `headers` field.\n\nSensitive headers that have been redacted are returned in the sensitive field.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointHeadersOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.getHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.getHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.get_headers(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.get_headers(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.GetHeaders(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.endpoint.getHeaders(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEndpoint()\n .getHeaders(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.endpoint.get_headers(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .get_headers(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.GetHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->getHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint get-headers \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/headers' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"put": {
"tags": [
"Endpoint"
],
"summary": "Update Endpoint Headers",
"description": "Set the additional headers to be sent with the webhook.",
"operationId": "v1.endpoint.update-headers",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointHeadersIn"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.endpoint.updateHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n headers: { \"X-Example\": \"123\", \"X-Foobar\": \"Bar\" },\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.endpoint.updateHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n headers: { \"X-Example\": \"123\", \"X-Foobar\": \"Bar\" },\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.endpoint.update_headers(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointHeadersIn(\n headers={\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.endpoint.update_headers(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointHeadersIn(\n headers={\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Endpoint.UpdateHeaders(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tEndpointHeadersIn{Headers: map[string]string{\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"}},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.endpoint.updateHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointHeadersIn(headers = mapOf(\"X-Example\" to \"123\", \"X-Foobar\" to \"Bar\")),\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getEndpoint()\n .updateHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointHeadersIn()\n .headers(\n Map.ofEntries(Map.entry(\"X-Example\", \"123\"), Map.entry(\"X-Foobar\", \"Bar\"))));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .endpoint\n .update_headers(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {headers: {:\"X-Example\" => \"123\", :\"X-Foobar\" => \"Bar\"}}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.endpoint()\n .update_headers(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n EndpointHeadersIn {\n headers: HashMap::from([\n (\"X-Example\".to_string(), \"123\".to_string()),\n (\"X-Foobar\".to_string(), \"Bar\".to_string()),\n ]),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.UpdateHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointHeadersIn\n {\n Headers = new() { { \"X-Example\", \"123\" }, { \"X-Foobar\", \"Bar\" } },\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->endpoint->updateHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointHeadersIn::create(\n headers: [\"X-Example\" => \"123\", \"X-Foobar\" => \"Bar\"]\n )\n\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint update-headers \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"headers\": {\n \"X-Example\": \"123\",\n \"X-Foobar\": \"Bar\"\n }\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PUT' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/headers' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"headers\": {\n \"X-Example\": \"123\",\n \"X-Foobar\": \"Bar\"\n }\n }'"
}
]
},
"patch": {
"tags": [
"Endpoint"
],
"summary": "Patch Endpoint Headers",
"description": "Partially set the additional headers to be sent with the webhook.",
"operationId": "v1.endpoint.patch-headers",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointHeadersPatchIn"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.endpoint.patchHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n headers: { \"X-Example\": \"123\", \"X-Foobar\": \"Bar\" },\n deleteHeaders: [],\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.endpoint.patchHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n headers: { \"X-Example\": \"123\", \"X-Foobar\": \"Bar\" },\n deleteHeaders: [],\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.endpoint.patch_headers(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointHeadersPatchIn(\n headers={\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n delete_headers=[],\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.endpoint.patch_headers(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointHeadersPatchIn(\n headers={\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n delete_headers=[],\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Endpoint.PatchHeaders(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tEndpointHeadersPatchIn{\n\t\tHeaders: map[string]string{\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n\t\tDeleteHeaders: []string{},\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.endpoint.patchHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointHeadersPatchIn(\n headers = mapOf(\"X-Example\" to \"123\", \"X-Foobar\" to \"Bar\"),\n deleteHeaders = listOf(),\n ),\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getEndpoint()\n .patchHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointHeadersPatchIn()\n .headers(Map.ofEntries(Map.entry(\"X-Example\", \"123\"), Map.entry(\"X-Foobar\", \"Bar\")))\n .deleteHeaders(List.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .endpoint\n .patch_headers(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {headers: {:\"X-Example\" => \"123\", :\"X-Foobar\" => \"Bar\"}, deleteHeaders: []}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.endpoint()\n .patch_headers(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n EndpointHeadersPatchIn {\n headers: HashMap::from([\n (\"X-Example\".to_string(), \"123\".to_string()),\n (\"X-Foobar\".to_string(), \"Bar\".to_string()),\n ]),\n delete_headers: Some(vec![]),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.PatchHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointHeadersPatchIn\n {\n Headers = new() { { \"X-Example\", \"123\" }, { \"X-Foobar\", \"Bar\" } },\n DeleteHeaders = [],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->endpoint->patchHeaders(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointHeadersPatchIn::create(\n headers: [\"X-Example\" => \"123\", \"X-Foobar\" => \"Bar\"]\n )\n ->withDeleteHeaders([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint patch-headers \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"deleteHeaders\": [],\n \"headers\": {\n \"X-Example\": \"123\",\n \"X-Foobar\": \"Bar\"\n }\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PATCH' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/headers' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"deleteHeaders\": [],\n \"headers\": {\n \"X-Example\": \"123\",\n \"X-Foobar\": \"Bar\"\n }\n }'"
}
]
}
},
"/api/v1/app/{app_id}/endpoint/{endpoint_id}/msg": {
"get": {
"tags": [
"Message Attempt"
],
"summary": "List Attempted Messages",
"description": "List messages for a particular endpoint. Additionally includes metadata about the latest message attempt.\n\nThe `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.\n\nNote that by default this endpoint is limited to retrieving 90 days' worth of data\nrelative to now or, if an iterator is provided, 90 days before/after the time indicated\nby the iterator ID. If you require data beyond those time ranges, you will need to explicitly\nset the `before` or `after` parameter as appropriate.\n",
"operationId": "v1.message-attempt.list-attempted-messages",
"parameters": [
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 31,
"minLength": 31,
"pattern": "^msg_[A-Za-z0-9]{27}$",
"nullable": true,
"example": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "form"
},
{
"in": "query",
"name": "channel",
"description": "Filter response based on the channel",
"schema": {
"description": "Filter response based on the channel",
"type": "string",
"maxLength": 128,
"pattern": "^[a-zA-Z0-9\\-_.:]+$",
"nullable": true,
"example": "project_1337"
},
"style": "form"
},
{
"in": "query",
"name": "tag",
"description": "Filter response based on the message tags",
"schema": {
"description": "Filter response based on the message tags",
"type": "string",
"maxLength": 128,
"pattern": "^[a-zA-Z0-9\\-_./\\\\#]+$",
"nullable": true,
"example": "project_1337"
},
"style": "form"
},
{
"in": "query",
"name": "status",
"description": "Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), or Sending (3)",
"schema": {
"description": "Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), or Sending (3)",
"$ref": "#/components/schemas/MessageStatus",
"nullable": true
},
"explode": false,
"style": "form"
},
{
"in": "query",
"name": "before",
"description": "Only include items created before a certain date",
"schema": {
"description": "Only include items created before a certain date",
"type": "string",
"format": "date-time",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "after",
"description": "Only include items created after a certain date",
"schema": {
"description": "Only include items created after a certain date",
"type": "string",
"format": "date-time",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "with_content",
"description": "When `true` message payloads are included in the response",
"schema": {
"description": "When `true` message payloads are included in the response",
"default": true,
"type": "boolean"
},
"style": "form"
},
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "query",
"name": "event_types",
"description": "Filter response based on the event type",
"schema": {
"description": "Filter response based on the event type",
"type": "array",
"items": {
"description": "The event type's name",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "user.signup"
},
"uniqueItems": true,
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_EndpointMessageOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.messageAttempt.listAttemptedMessages(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.messageAttempt.listAttemptedMessages(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message_attempt.list_attempted_messages(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message_attempt.list_attempted_messages(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.MessageAttempt.ListAttemptedMessages(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.messageAttempt.listAttemptedMessages(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessageAttempt()\n .listAttemptedMessages(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .message_attempt\n .list_attempted_messages(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message_attempt()\n .list_attempted_messages(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.MessageAttempt.ListAttemptedMessages(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->messageAttempt->listAttemptedMessages(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message-attempt list-attempted-messages \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/msg' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/endpoint/{endpoint_id}/recover": {
"post": {
"tags": [
"Endpoint"
],
"summary": "Recover Failed Webhooks",
"description": "Resend all failed messages since a given time.\n\nMessages that were sent successfully, even if failed initially, are not resent.\n\nA completed task will return a payload like the following:\n```json\n{\n \"id\": \"qtask_33qen93MNuelBAq1T9G7eHLJRsF\",\n \"status\": \"finished\",\n \"task\": \"endpoint.recover\",\n \"data\": {\n \"messagesSent\": 2\n }\n}\n```",
"operationId": "v1.endpoint.recover",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecoverIn"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecoverOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.recover(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n since: new Date(\"2025-10-02T20:28:42+00:00\"),\n until: new Date(\"2025-10-02T20:28:42+00:00\"),\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.recover(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n since: new Date(\"2025-10-02T20:28:42+00:00\"),\n until: new Date(\"2025-10-02T20:28:42+00:00\"),\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.recover(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n RecoverIn(\n since=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n until=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.recover(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n RecoverIn(\n since=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n until=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.Recover(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tRecoverIn{\n\t\tSince: time.Date(2025, 10, 2, 20, 28, 42, 0, time.UTC),\n\t\tUntil: ptr(time.Date(2025, 10, 2, 20, 28, 42, 0, time.UTC)),\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.endpoint.recover(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n RecoverIn(\n since = Instant.parse(\"2025-10-02T20:28:42+00:00\"),\n until = Instant.parse(\"2025-10-02T20:28:42+00:00\"),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEndpoint()\n .recover(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new RecoverIn()\n .since(OffsetDateTime.parse(\"2025-10-02T20:28:42+00:00\"))\n .until(OffsetDateTime.parse(\"2025-10-02T20:28:42+00:00\")));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .endpoint\n .recover(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {since: \"2025-10-02T20:28:42+00:00\", until: \"2025-10-02T20:28:42+00:00\"}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .recover(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n RecoverIn {\n since: \"2025-10-02T20:28:42+00:00\".to_string(),\n until: Some(\"2025-10-02T20:28:42+00:00\".to_string()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.Recover(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new RecoverIn\n {\n Since = DateTime.Parse(\"2025-10-02T20:28:42+00:00\"),\n Until = DateTime.Parse(\"2025-10-02T20:28:42+00:00\"),\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->recover(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n RecoverIn::create(\n since: new DateTimeImmutable(\"2025-10-02T20:28:42+00:00\")\n )\n ->withUntil(new DateTimeImmutable(\"2025-10-02T20:28:42+00:00\"))\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint recover \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"since\": \"2025-10-02T20:28:42+00:00\",\n \"until\": \"2025-10-02T20:28:42+00:00\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/recover' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"since\": \"2025-10-02T20:28:42+00:00\",\n \"until\": \"2025-10-02T20:28:42+00:00\"\n }'"
}
]
}
},
"/api/v1/app/{app_id}/endpoint/{endpoint_id}/replay-missing": {
"post": {
"tags": [
"Endpoint"
],
"summary": "Replay Missing Webhooks",
"description": "Replays messages to the endpoint.\n\nOnly messages that were created after `since` will be sent.\nMessages that were previously sent to the endpoint are not resent.\n\nA completed task will return a payload like the following:\n```json\n{\n \"id\": \"qtask_33qen93MNuelBAq1T9G7eHLJRsF\",\n \"status\": \"finished\",\n \"task\": \"endpoint.replay\",\n \"data\": {\n \"messagesSent\": 2\n }\n}\n```",
"operationId": "v1.endpoint.replay-missing",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReplayIn"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReplayOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.replayMissing(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n since: new Date(\"2025-10-02T20:28:42+00:00\"),\n until: new Date(\"2025-10-02T20:28:42+00:00\"),\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.replayMissing(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n since: new Date(\"2025-10-02T20:28:42+00:00\"),\n until: new Date(\"2025-10-02T20:28:42+00:00\"),\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.replay_missing(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n ReplayIn(\n since=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n until=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.replay_missing(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n ReplayIn(\n since=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n until=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.ReplayMissing(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tReplayIn{\n\t\tSince: time.Date(2025, 10, 2, 20, 28, 42, 0, time.UTC),\n\t\tUntil: ptr(time.Date(2025, 10, 2, 20, 28, 42, 0, time.UTC)),\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.endpoint.replayMissing(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n ReplayIn(\n since = Instant.parse(\"2025-10-02T20:28:42+00:00\"),\n until = Instant.parse(\"2025-10-02T20:28:42+00:00\"),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEndpoint()\n .replayMissing(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new ReplayIn()\n .since(OffsetDateTime.parse(\"2025-10-02T20:28:42+00:00\"))\n .until(OffsetDateTime.parse(\"2025-10-02T20:28:42+00:00\")));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .endpoint\n .replay_missing(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {since: \"2025-10-02T20:28:42+00:00\", until: \"2025-10-02T20:28:42+00:00\"}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .replay_missing(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n ReplayIn {\n since: \"2025-10-02T20:28:42+00:00\".to_string(),\n until: Some(\"2025-10-02T20:28:42+00:00\".to_string()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.ReplayMissing(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new ReplayIn\n {\n Since = DateTime.Parse(\"2025-10-02T20:28:42+00:00\"),\n Until = DateTime.Parse(\"2025-10-02T20:28:42+00:00\"),\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->replayMissing(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n ReplayIn::create(\n since: new DateTimeImmutable(\"2025-10-02T20:28:42+00:00\")\n )\n ->withUntil(new DateTimeImmutable(\"2025-10-02T20:28:42+00:00\"))\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint replay-missing \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"since\": \"2025-10-02T20:28:42+00:00\",\n \"until\": \"2025-10-02T20:28:42+00:00\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/replay-missing' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"since\": \"2025-10-02T20:28:42+00:00\",\n \"until\": \"2025-10-02T20:28:42+00:00\"\n }'"
}
]
}
},
"/api/v1/app/{app_id}/endpoint/{endpoint_id}/secret": {
"get": {
"tags": [
"Endpoint"
],
"summary": "Get Endpoint Secret",
"description": "Get the endpoint's signing secret.\n\nThis is used to verify the authenticity of the webhook.\nFor more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).",
"operationId": "v1.endpoint.get-secret",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointSecretOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.getSecret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.getSecret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.get_secret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.get_secret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.GetSecret(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.endpoint.getSecret(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEndpoint()\n .getSecret(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.endpoint.get_secret(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .get_secret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.GetSecret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->getSecret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint get-secret \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/secret' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/rotate": {
"post": {
"tags": [
"Endpoint"
],
"summary": "Rotate Endpoint Secret",
"description": "Rotates the endpoint's signing secret.\n\nThe previous secret will remain valid for the next 24 hours.",
"operationId": "v1.endpoint.rotate-secret",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointSecretRotateIn"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.endpoint.rotateSecret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n key: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.endpoint.rotateSecret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n key: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.endpoint.rotate_secret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointSecretRotateIn(\n key=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.endpoint.rotate_secret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointSecretRotateIn(\n key=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Endpoint.RotateSecret(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tEndpointSecretRotateIn{Key: ptr(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.endpoint.rotateSecret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointSecretRotateIn(key = \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"),\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getEndpoint()\n .rotateSecret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointSecretRotateIn().key(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .endpoint\n .rotate_secret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {key: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.endpoint()\n .rotate_secret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n EndpointSecretRotateIn {\n key: Some(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\".to_string()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.RotateSecret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointSecretRotateIn { Key = \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\" }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->endpoint->rotateSecret(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointSecretRotateIn::create()\n ->withKey(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint rotate-secret \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"key\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/secret/rotate' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"key\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n }'"
}
]
}
},
"/api/v1/app/{app_id}/endpoint/{endpoint_id}/send-example": {
"post": {
"tags": [
"Endpoint"
],
"summary": "Send Event Type Example Message",
"description": "Send an example message for an event.",
"operationId": "v1.endpoint.send-example",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventExampleIn"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.sendExample(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n eventType: \"user.signup\",\n exampleIndex: 1,\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.sendExample(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n eventType: \"user.signup\",\n exampleIndex: 1,\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.send_example(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EventExampleIn(\n event_type=\"user.signup\",\n example_index=1,\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.send_example(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EventExampleIn(\n event_type=\"user.signup\",\n example_index=1,\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.SendExample(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tEventExampleIn{EventType: \"user.signup\", ExampleIndex: ptr(uint64(1))},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.endpoint.sendExample(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EventExampleIn(eventType = \"user.signup\", exampleIndex = 1u),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEndpoint()\n .sendExample(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EventExampleIn().eventType(\"user.signup\").exampleIndex(1L));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .endpoint\n .send_example(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {eventType: \"user.signup\", exampleIndex: 1}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .send_example(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n EventExampleIn {\n event_type: \"user.signup\".to_string(),\n example_index: Some(1),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.SendExample(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EventExampleIn { EventType = \"user.signup\", ExampleIndex = 1 }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->sendExample(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EventExampleIn::create(\n eventType: \"user.signup\"\n )\n ->withExampleIndex(1)\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint send-example \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"eventType\": \"user.signup\",\n \"exampleIndex\": 1\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/send-example' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"eventType\": \"user.signup\",\n \"exampleIndex\": 1\n }'"
}
]
}
},
"/api/v1/app/{app_id}/endpoint/{endpoint_id}/stats": {
"get": {
"tags": [
"Endpoint"
],
"summary": "Endpoint Stats",
"description": "Get basic statistics for the endpoint.",
"operationId": "v1.endpoint.get-stats",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "query",
"name": "since",
"description": "Filter the range to data starting from this date.",
"schema": {
"description": "Filter the range to data starting from this date.",
"type": "string",
"format": "date-time",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "until",
"description": "Filter the range to data ending by this date.",
"schema": {
"description": "Filter the range to data ending by this date.",
"type": "string",
"format": "date-time",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointStats"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.getStats(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.getStats(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.get_stats(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.get_stats(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.GetStats(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.endpoint.getStats(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEndpoint()\n .getStats(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.endpoint.get_stats(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .get_stats(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.GetStats(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->getStats(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint get-stats \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/stats' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation": {
"get": {
"tags": [
"Endpoint"
],
"summary": "Get Endpoint Transformation",
"description": "Get the transformation code associated with this endpoint.",
"operationId": "v1.endpoint.transformation-get",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointTransformationOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.endpoint.transformationGet(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.endpoint.transformationGet(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.endpoint.transformation_get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.endpoint.transformation_get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Endpoint.TransformationGet(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.endpoint.transformationGet(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEndpoint()\n .transformationGet(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.endpoint.transformation_get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .endpoint()\n .transformation_get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.TransformationGet(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->endpoint->transformationGet(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint transformation-get \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/transformation' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"patch": {
"tags": [
"Endpoint"
],
"summary": "Patch Endpoint Transformation",
"description": "Set or unset the transformation code associated with this endpoint.",
"operationId": "v1.endpoint.patch-transformation",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointTransformationPatch"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.endpoint.patchTransformation(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n code: \"function handler(webhook) { /* ... */ }\",\n enabled: true,\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.endpoint.patchTransformation(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n code: \"function handler(webhook) { /* ... */ }\",\n enabled: true,\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.endpoint.patch_transformation(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointTransformationPatch(\n code=\"function handler(webhook) { /* ... */ }\",\n enabled=True,\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.endpoint.patch_transformation(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointTransformationPatch(\n code=\"function handler(webhook) { /* ... */ }\",\n enabled=True,\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Endpoint.PatchTransformation(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tEndpointTransformationPatch{\n\t\tCode: NewNullable(\"function handler(webhook) { /* ... */ }\"),\n\t\tEnabled: ptr(true),\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.endpoint.patchTransformation(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointTransformationPatch(\n code = MaybeUnset.Present(\"function handler(webhook) { /* ... */ }\"),\n enabled = true,\n ),\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getEndpoint()\n .patchTransformation(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointTransformationPatch()\n .code(\"function handler(webhook) { /* ... */ }\")\n .enabled(true));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .endpoint\n .patch_transformation(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {code: \"function handler(webhook) { /* ... */ }\", enabled: true}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.endpoint()\n .patch_transformation(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n EndpointTransformationPatch {\n code: js_option::JsOption::Some(\n \"function handler(webhook) { /* ... */ }\".to_string(),\n ),\n enabled: Some(true),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Endpoint.PatchTransformation(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointTransformationPatch\n {\n Code = \"function handler(webhook) { /* ... */ }\",\n Enabled = true,\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->endpoint->patchTransformation(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointTransformationPatch::create()\n ->withCode(\"function handler(webhook) { /* ... */ }\")\n ->withEnabled(true)\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix endpoint patch-transformation \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"code\": \"function handler(webhook) { /* ... */ }\",\n \"enabled\": true\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PATCH' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/transformation' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"code\": \"function handler(webhook) { /* ... */ }\",\n \"enabled\": true\n }'"
}
]
}
},
"/api/v1/app/{app_id}/integration": {
"get": {
"tags": [
"Integration"
],
"summary": "List Integrations",
"description": "List the application's integrations.",
"operationId": "v1.integration.list",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 33,
"minLength": 33,
"pattern": "^integ_[A-Za-z0-9]{27}$",
"nullable": true,
"example": "integ_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "form"
},
{
"in": "query",
"name": "order",
"description": "The sorting order of the returned items",
"schema": {
"description": "The sorting order of the returned items",
"$ref": "#/components/schemas/Ordering",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_IntegrationOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.integration.list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.integration.list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.integration.list(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.integration.list(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Integration.List(ctx, \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.integration.list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getIntegration().list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.integration.list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .integration()\n .list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(), None)\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Integration.List(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->integration->list(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix integration list \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/integration' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"post": {
"tags": [
"Integration"
],
"summary": "Create Integration",
"description": "Create an integration.",
"operationId": "v1.integration.create",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationIn"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.integration.create(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n name: \"Example Integration\",\n featureFlags: [],\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.integration.create(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n name: \"Example Integration\",\n featureFlags: [],\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.integration.create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n IntegrationIn(\n name=\"Example Integration\",\n feature_flags=[],\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.integration.create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n IntegrationIn(\n name=\"Example Integration\",\n feature_flags=[],\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Integration.Create(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\tIntegrationIn{Name: \"Example Integration\", FeatureFlags: []string{}},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.integration.create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n IntegrationIn(name = \"Example Integration\", featureFlags = setOf()),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getIntegration()\n .create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new IntegrationIn().name(\"Example Integration\").featureFlags(Set.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.integration.create(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {name: \"Example Integration\", featureFlags: []})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .integration()\n .create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n IntegrationIn {\n name: \"Example Integration\".to_string(),\n feature_flags: Some(vec![]),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Integration.Create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new IntegrationIn { Name = \"Example Integration\", FeatureFlags = [] }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->integration->create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n IntegrationIn::create(\n name: \"Example Integration\"\n )\n ->withFeatureFlags([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix integration create \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" '{\n \"featureFlags\": [],\n \"name\": \"Example Integration\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/integration' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"featureFlags\": [],\n \"name\": \"Example Integration\"\n }'"
}
]
}
},
"/api/v1/app/{app_id}/integration/{integ_id}": {
"get": {
"tags": [
"Integration"
],
"summary": "Get Integration",
"description": "Get an integration.",
"operationId": "v1.integration.get",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "integ_id",
"description": "The Integration's ID.",
"required": true,
"schema": {
"description": "The Integration's ID.",
"type": "string",
"maxLength": 33,
"minLength": 33,
"pattern": "^integ_[A-Za-z0-9]{27}$",
"example": "integ_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.integration.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.integration.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.integration.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.integration.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Integration.Get(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.integration.get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getIntegration()\n .get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.integration.get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .integration()\n .get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Integration.Get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->integration->get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix integration get \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/integration/integ_1srOrx2ZWZBpBUvZwXKQmoEYga2' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"put": {
"tags": [
"Integration"
],
"summary": "Update Integration",
"description": "Update an integration.",
"operationId": "v1.integration.update",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "integ_id",
"description": "The Integration's ID.",
"required": true,
"schema": {
"description": "The Integration's ID.",
"type": "string",
"maxLength": 33,
"minLength": 33,
"pattern": "^integ_[A-Za-z0-9]{27}$",
"example": "integ_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.integration.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n {\n name: \"Example Integration\",\n featureFlags: [],\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.integration.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n {\n name: \"Example Integration\",\n featureFlags: [],\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.integration.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n IntegrationUpdate(\n name=\"Example Integration\",\n feature_flags=[],\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.integration.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n IntegrationUpdate(\n name=\"Example Integration\",\n feature_flags=[],\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Integration.Update(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\tIntegrationUpdate{Name: \"Example Integration\", FeatureFlags: []string{}},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.integration.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n IntegrationUpdate(name = \"Example Integration\", featureFlags = setOf()),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getIntegration()\n .update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new IntegrationUpdate().name(\"Example Integration\").featureFlags(Set.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .integration\n .update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n {name: \"Example Integration\", featureFlags: []}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .integration()\n .update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n IntegrationUpdate {\n name: \"Example Integration\".to_string(),\n feature_flags: Some(vec![]),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Integration.Update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new IntegrationUpdate { Name = \"Example Integration\", FeatureFlags = [] }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->integration->update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n IntegrationUpdate::create(\n name: \"Example Integration\"\n )\n ->withFeatureFlags([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix integration update \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\" '{\n \"featureFlags\": [],\n \"name\": \"Example Integration\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PUT' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/integration/integ_1srOrx2ZWZBpBUvZwXKQmoEYga2' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"featureFlags\": [],\n \"name\": \"Example Integration\"\n }'"
}
]
},
"delete": {
"tags": [
"Integration"
],
"summary": "Delete Integration",
"description": "Delete an integration.",
"operationId": "v1.integration.delete",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "integ_id",
"description": "The Integration's ID.",
"required": true,
"schema": {
"description": "The Integration's ID.",
"type": "string",
"maxLength": 33,
"minLength": 33,
"pattern": "^integ_[A-Za-z0-9]{27}$",
"example": "integ_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.integration.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.integration.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.integration.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.integration.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Integration.Delete(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.integration.delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getIntegration()\n .delete(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.integration.delete(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.integration()\n .delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Integration.Delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->integration->delete(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix integration delete \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'DELETE' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/integration/integ_1srOrx2ZWZBpBUvZwXKQmoEYga2' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
}
},
"/api/v1/app/{app_id}/integration/{integ_id}/key": {
"get": {
"tags": [
"Integration"
],
"summary": "Get Integration Key",
"description": "Get an integration's key.",
"operationId": "v1.integration.get-key",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "integ_id",
"description": "The Integration's ID.",
"required": true,
"schema": {
"description": "The Integration's ID.",
"type": "string",
"maxLength": 33,
"minLength": 33,
"pattern": "^integ_[A-Za-z0-9]{27}$",
"example": "integ_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationKeyOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"deprecated": true,
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.integration.getKey(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.integration.getKey(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.integration.get_key(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.integration.get_key(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Integration.GetKey(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.integration.getKey(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getIntegration()\n .getKey(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.integration.get_key(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .integration()\n .get_key(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Integration.GetKey(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->integration->getKey(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix integration get-key \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/integration/integ_1srOrx2ZWZBpBUvZwXKQmoEYga2/key' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/integration/{integ_id}/key/rotate": {
"post": {
"tags": [
"Integration"
],
"summary": "Rotate Integration Key",
"description": "Rotate the integration's key. The previous key will be immediately revoked.",
"operationId": "v1.integration.rotate-key",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "integ_id",
"description": "The Integration's ID.",
"required": true,
"schema": {
"description": "The Integration's ID.",
"type": "string",
"maxLength": 33,
"minLength": 33,
"pattern": "^integ_[A-Za-z0-9]{27}$",
"example": "integ_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationKeyOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.integration.rotateKey(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.integration.rotateKey(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.integration.rotate_key(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.integration.rotate_key(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Integration.RotateKey(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.integration.rotateKey(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getIntegration()\n .rotateKey(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.integration.rotate_key(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .integration()\n .rotate_key(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Integration.RotateKey(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->integration->rotateKey(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix integration rotate-key \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"integ_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/integration/integ_1srOrx2ZWZBpBUvZwXKQmoEYga2/key/rotate' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/msg": {
"get": {
"tags": [
"Message"
],
"summary": "List Messages",
"description": "List all of the application's messages.\n\nThe `before` and `after` parameters let you filter all items created before or after a certain date. These can be\nused alongside an iterator to paginate over results within a certain window.\n\nNote that by default this endpoint is limited to retrieving 90 days' worth of data\nrelative to now or, if an iterator is provided, 90 days before/after the time indicated\nby the iterator ID. If you require data beyond those time ranges, you will need to explicitly\nset the `before` or `after` parameter as appropriate.",
"operationId": "v1.message.list",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 31,
"minLength": 31,
"pattern": "^msg_[A-Za-z0-9]{27}$",
"nullable": true,
"example": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "form"
},
{
"in": "query",
"name": "channel",
"description": "Filter response based on the channel.",
"schema": {
"description": "Filter response based on the channel.",
"type": "string",
"maxLength": 128,
"pattern": "^[a-zA-Z0-9\\-_.:]+$",
"nullable": true,
"example": "project_1337"
},
"style": "form"
},
{
"in": "query",
"name": "before",
"description": "Only include items created before a certain date.",
"schema": {
"description": "Only include items created before a certain date.",
"type": "string",
"format": "date-time",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "after",
"description": "Only include items created after a certain date.",
"schema": {
"description": "Only include items created after a certain date.",
"type": "string",
"format": "date-time",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "with_content",
"description": "When `true` message payloads are included in the response.",
"schema": {
"description": "When `true` message payloads are included in the response.",
"default": true,
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "tag",
"description": "Filter messages matching the provided tag.",
"schema": {
"description": "Filter messages matching the provided tag.",
"type": "string",
"maxLength": 128,
"pattern": "^[a-zA-Z0-9\\-_./\\\\#]+$",
"nullable": true,
"example": "project_1337"
},
"style": "form"
},
{
"in": "query",
"name": "event_types",
"description": "Filter response based on the event type",
"schema": {
"description": "Filter response based on the event type",
"type": "array",
"items": {
"description": "The event type's name",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "user.signup"
},
"uniqueItems": true,
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_MessageOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.message.list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.message.list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message.list(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message.list(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Message.List(ctx, \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.message.list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessage().list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.message.list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message()\n .list(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(), None)\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Message.List(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->message->list(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message list \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/msg' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"post": {
"tags": [
"Message"
],
"summary": "Create Message",
"description": "Creates a new message and dispatches it to all of the application's endpoints.\n\nThe `eventId` is an optional custom unique ID. It's verified to be unique only up to a day, after that no verification will be made.\nIf a message with the same `eventId` already exists for the application, a 409 conflict error will be returned.\n\nThe `eventType` indicates the type and schema of the event. All messages of a certain `eventType` are expected to have the same schema. Endpoints can choose to only listen to specific event types.\nMessages can also have `channels`, which similar to event types let endpoints filter by them. Unlike event types, messages can have multiple channels, and channels don't imply a specific message content or schema.\n\nThe `payload` property is the webhook's body (the actual webhook message). Svix supports payload sizes of up to 1MiB, though it's generally a good idea to keep webhook payloads small, probably no larger than 40kb.",
"operationId": "v1.message.create",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "query",
"name": "with_content",
"description": "When `true`, message payloads are included in the response.",
"schema": {
"description": "When `true`, message payloads are included in the response.",
"default": true,
"type": "boolean"
},
"style": "form"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageIn"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"413": {
"description": "Payload too large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.message.create(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n eventId: \"unique-identifier\",\n eventType: \"user.signup\",\n payload: { email: \"test@example.com\", type: \"user.created\", username: \"test_user\" },\n channels: [\"project_123\", \"group_2\"],\n application: {\n name: \"My first application\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n metadata: {},\n },\n tags: [\"my_tag\", \"other\"],\n transformationsParams: {},\n deliverAt: new Date(\"2025-10-02T20:28:42+00:00\"),\n payloadRetentionPeriod: 90,\n payloadRetentionHours: 1,\n});\n\n// Alternatively, with a raw string payload.\nconst response = await svix.message.create(\n \"app_id\",\n messageInRaw(\"user.signup\", \"This is a raw body.\", \"text/plain\")\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.message.create(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n eventId: \"unique-identifier\",\n eventType: \"user.signup\",\n payload: { email: \"test@example.com\", type: \"user.created\", username: \"test_user\" },\n channels: [\"project_123\", \"group_2\"],\n application: {\n name: \"My first application\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n metadata: {},\n },\n tags: [\"my_tag\", \"other\"],\n transformationsParams: {},\n deliverAt: new Date(\"2025-10-02T20:28:42+00:00\"),\n payloadRetentionPeriod: 90,\n payloadRetentionHours: 1,\n});\n\n// Alternatively, with a raw string payload.\nconst response = await svix.message.create(\n \"app_id\",\n messageInRaw(\"user.signup\", \"This is a raw body.\", \"text/plain\")\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message.create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n MessageIn(\n event_id=\"unique-identifier\",\n event_type=\"user.signup\",\n payload={\n \"email\": \"test@example.com\",\n \"type\": \"user.created\",\n \"username\": \"test_user\",\n },\n channels=[\n \"project_123\",\n \"group_2\",\n ],\n application=ApplicationIn(\n name=\"My first application\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n metadata={},\n ),\n tags=[\n \"my_tag\",\n \"other\",\n ],\n transformations_params={},\n deliver_at=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n payload_retention_period=90,\n payload_retention_hours=1,\n ),\n)\n\n# Alternatively, with a raw string payload.\nresponse = svix.message.create(\n \"app_id\",\n message_in_raw(\n event_type=\"user.signup\",\n payload=\"This is a raw body.\",\n content_type=\"text/plain\",\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message.create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n MessageIn(\n event_id=\"unique-identifier\",\n event_type=\"user.signup\",\n payload={\n \"email\": \"test@example.com\",\n \"type\": \"user.created\",\n \"username\": \"test_user\",\n },\n channels=[\n \"project_123\",\n \"group_2\",\n ],\n application=ApplicationIn(\n name=\"My first application\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n metadata={},\n ),\n tags=[\n \"my_tag\",\n \"other\",\n ],\n transformations_params={},\n deliver_at=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n payload_retention_period=90,\n payload_retention_hours=1,\n ),\n)\n\n# Alternatively, with a raw string payload.\nresponse = await svix.message.create(\n \"app_id\",\n message_in_raw(\n event_type=\"user.signup\",\n payload=\"This is a raw body.\",\n content_type=\"text/plain\",\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Message.Create(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\tMessageIn{\n\t\tEventId: ptr(\"unique-identifier\"),\n\t\tEventType: \"user.signup\",\n\t\tPayload: map[string]any{\n\t\t\t\"email\": \"test@example.com\",\n\t\t\t\"type\": \"user.created\",\n\t\t\t\"username\": \"test_user\",\n\t\t},\n\t\tChannels: []string{\"project_123\", \"group_2\"},\n\t\tApplication: ptr(\n\t\t\tApplicationIn{\n\t\t\t\tName: \"My first application\",\n\t\t\t\tRateLimit: ptr(uint16(1)),\n\t\t\t\tThrottleRate: ptr(uint16(1)),\n\t\t\t\tUid: ptr(\"unique-identifier\"),\n\t\t\t\tMetadata: nil,\n\t\t\t},\n\t\t),\n\t\tTags: []string{\"my_tag\", \"other\"},\n\t\tTransformationsParams: nil,\n\t\tDeliverAt: ptr(time.Date(2025, 10, 2, 20, 28, 42, 0, time.UTC)),\n\t\tPayloadRetentionPeriod: ptr(int64(90)),\n\t\tPayloadRetentionHours: ptr(int64(1)),\n\t},\n\tnil,\n)\n\n// Alternatively, with a raw string payload.\nresponse, err := svix.Message.Create(ctx, \"app_id\", &NewMessageInRaw(\n\t\"user.signup\",\n\t\"This is a raw body.\",\n\t&\"text/plain\",\n))"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.message.create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n MessageIn(\n eventId = \"unique-identifier\",\n eventType = \"user.signup\",\n payload =\n \"{\\\"email\\\": \\\"test@example.com\\\",\\\"type\\\": \\\"user.created\\\",\\\"username\\\": \\\"test_user\\\"}\",\n channels = setOf(\"project_123\", \"group_2\"),\n application =\n ApplicationIn(\n name = \"My first application\",\n rateLimit = 1u,\n throttleRate = 1u,\n uid = \"unique-identifier\",\n metadata = mapOf(),\n ),\n tags = setOf(\"my_tag\", \"other\"),\n transformationsParams = mapOf(),\n deliverAt = Instant.parse(\"2025-10-02T20:28:42+00:00\"),\n payloadRetentionPeriod = 90,\n payloadRetentionHours = 1,\n ),\n )\n\n// Alternatively, with a raw string payload.\nval response =\n svix.message.create(\n \"app_id\",\n messageInRaw(\n eventType = \"user.signup\",\n payload = \"This is a raw body.\",\n contentType = \"text/plain\",\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessage()\n .create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new MessageIn()\n .eventId(\"unique-identifier\")\n .eventType(\"user.signup\")\n .payload(\"{\\\"email\\\": \\\"test@example.com\\\",\\\"type\\\": \\\"user.created\\\",\\\"username\\\":\"\n + \" \\\"test_user\\\"}\")\n .channels(Set.of(\"project_123\", \"group_2\"))\n .application(new ApplicationIn()\n .name(\"My first application\")\n .rateLimit(1L)\n .throttleRate(1L)\n .uid(\"unique-identifier\")\n .metadata(Map.of()))\n .tags(Set.of(\"my_tag\", \"other\"))\n .transformationsParams(Map.of())\n .deliverAt(OffsetDateTime.parse(\"2025-10-02T20:28:42+00:00\"))\n .payloadRetentionPeriod(90L)\n .payloadRetentionHours(1L));\n\n // Alternatively, with a raw string payload.\n var response = svix.getMessage()\n .create(\n \"app_id\",\n Message.messageInRaw(\"This is a raw body.\", \"text/plain\").eventType(\"user.signup\"));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "# Alternatively, with a raw string payload.\nresponse = svix\n .message\n .create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n {\n eventId: \"unique-identifier\",\n eventType: \"user.signup\",\n payload: {\"email\" => \"test@example.com\", \"type\" => \"user.created\", \"username\" => \"test_user\"},\n channels: [\"project_123\", \"group_2\"],\n application: {\n name: \"My first application\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n metadata: {}\n },\n tags: [\"my_tag\", \"other\"],\n transformationsParams: {},\n deliverAt: \"2025-10-02T20:28:42+00:00\",\n payloadRetentionPeriod: 90,\n payloadRetentionHours: 1\n }\n )\nresponse = svix.message.create(\n \"app_id\",\n message_in_raw(\n payload: \"This is a raw body.\",\n eventType: \"user.signup\",\n content_type: \"test/plain\"\n )\n)"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message()\n .create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n MessageIn {\n event_id: Some(\"unique-identifier\".to_string()),\n event_type: \"user.signup\".to_string(),\n payload: serde_json::json!(\n { \"email\" : \"test@example.com\", \"type\" : \"user.created\", \"username\" :\n \"test_user\" }\n ),\n channels: Some(vec![\"project_123\".to_string(), \"group_2\".to_string()]),\n application: Some(ApplicationIn {\n name: \"My first application\".to_string(),\n rate_limit: Some(1),\n throttle_rate: Some(1),\n uid: Some(\"unique-identifier\".to_string()),\n metadata: Some(HashMap::new()),\n }),\n tags: Some(vec![\"my_tag\".to_string(), \"other\".to_string()]),\n transformations_params: Some(serde_json::json!({})),\n deliver_at: Some(\"2025-10-02T20:28:42+00:00\".to_string()),\n payload_retention_period: Some(90),\n payload_retention_hours: Some(1),\n },\n None,\n )\n .await?;\n/// Alternatively, with a raw string payload.\nlet response = svix\n .message()\n .create(\n \"app_id\",\n MessageIn::new_raw_payload(\n \"user.signup\".to_string(),\n \"This is a raw body.\".to_string(),\n )\n .with_content_type(\"text/plain\".to_string()),\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Message.Create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new MessageIn\n {\n EventId = \"unique-identifier\",\n EventType = \"user.signup\",\n Payload = new Dictionary<string, string>\n {\n { \"email\", \"test@example.com\" },\n { \"type\", \"user.created\" },\n { \"username\", \"test_user\" },\n },\n Channels = [\"project_123\", \"group_2\"],\n Application = new ApplicationIn\n {\n Name = \"My first application\",\n RateLimit = 1,\n ThrottleRate = 1,\n Uid = \"unique-identifier\",\n Metadata = [],\n },\n Tags = [\"my_tag\", \"other\"],\n TransformationsParams = new Dictionary<string, string> { },\n DeliverAt = DateTime.Parse(\"2025-10-02T20:28:42+00:00\"),\n PayloadRetentionPeriod = 90,\n PayloadRetentionHours = 1,\n }\n);\n\n// Alternatively, with a raw string payload.\nvar response = await svix.Message.CreateAsync(\n \"app_id\",\n svix.Message.messageInRaw(\n eventType: \"user.signup\",\n payload: \"This is a raw body.\",\n contentType: \"text/plain\"\n )\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->message->create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n MessageIn::create(\n eventType: \"user.signup\",\n payload: [\"email\" => \"test@example.com\", \"type\" => \"user.created\", \"username\" => \"test_user\"]\n )\n ->withEventId(\"unique-identifier\")\n ->withChannels([\"project_123\",\"group_2\"])\n ->withApplication(ApplicationIn::create(\n name: \"My first application\"\n )\n ->withRateLimit(1)\n ->withThrottleRate(1)\n ->withUid(\"unique-identifier\")\n ->withMetadata([]))\n ->withTags([\"my_tag\",\"other\"])\n ->withDeliverAt(new DateTimeImmutable(\"2025-10-02T20:28:42+00:00\"))\n ->withPayloadRetentionPeriod(90)\n ->withPayloadRetentionHours(1)\n);\n\n// Alternatively, with a raw string payload.\n$response = $svix->message->create(\n \"app_id\",\n MessageIn::createRaw(\n \"user.signup\",\n \"This is a raw body.\",\n \"text/plain\"\n )\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message create \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" '{\n \"application\": {\n \"metadata\": {},\n \"name\": \"My first application\",\n \"rateLimit\": 1,\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\"\n },\n \"channels\": [\n \"project_123\",\n \"group_2\"\n ],\n \"deliverAt\": \"2025-10-02T20:28:42+00:00\",\n \"eventId\": \"unique-identifier\",\n \"eventType\": \"user.signup\",\n \"payload\": {\n \"email\": \"test@example.com\",\n \"type\": \"user.created\",\n \"username\": \"test_user\"\n },\n \"payloadRetentionHours\": 1,\n \"payloadRetentionPeriod\": 90,\n \"tags\": [\n \"my_tag\",\n \"other\"\n ],\n \"transformationsParams\": {}\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/msg' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"application\": {\n \"metadata\": {},\n \"name\": \"My first application\",\n \"rateLimit\": 1,\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\"\n },\n \"channels\": [\n \"project_123\",\n \"group_2\"\n ],\n \"deliverAt\": \"2025-10-02T20:28:42+00:00\",\n \"eventId\": \"unique-identifier\",\n \"eventType\": \"user.signup\",\n \"payload\": {\n \"email\": \"test@example.com\",\n \"type\": \"user.created\",\n \"username\": \"test_user\"\n },\n \"payloadRetentionHours\": 1,\n \"payloadRetentionPeriod\": 90,\n \"tags\": [\n \"my_tag\",\n \"other\"\n ],\n \"transformationsParams\": {}\n }'\n\n\n# Alternatively, with a raw string payload.\ncurl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/{app_id}/msg' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"eventType\": \"user.signup\",\n \"payload\": {},\n \"transformationsParams\": {\n \"rawPayload\": \"This is a raw body.\",\n \"headers\": { \"content-type\": \"text/plain\" }\n }\n }'"
}
]
}
},
"/api/v1/app/{app_id}/msg/expunge-all-contents": {
"post": {
"tags": [
"Message"
],
"summary": "Expunge all message contents",
"description": "Delete all message payloads for the application.\n\nThis operation is only available in the <a href=\"https://svix.com/pricing\" target=\"_blank\">Enterprise</a> plan.\n\nA completed task will return a payload like the following:\n```json\n{\n \"id\": \"qtask_33qen93MNuelBAq1T9G7eHLJRsF\",\n \"status\": \"finished\",\n \"task\": \"application.purge_content\",\n \"data\": {\n \"messagesPurged\": 150\n }\n}\n```",
"operationId": "v1.message.expunge-all-contents",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"202": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExpungeAllContentsOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.message.expungeAllContents(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.message.expungeAllContents(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message.expunge_all_contents(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message.expunge_all_contents(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Message.ExpungeAllContents(ctx, \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.message.expungeAllContents(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessage().expungeAllContents(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.message.expunge_all_contents(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message()\n .expunge_all_contents(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(), None)\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Message.ExpungeAllContents(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->message->expungeAllContents(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message expunge-all-contents \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/msg/expunge-all-contents' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/msg/precheck/active": {
"post": {
"tags": [
"Message"
],
"summary": "Create Message Precheck",
"description": "A pre-check call for `message.create` that checks whether any active endpoints are\nlistening to this message.\n\nNote: most people shouldn't be using this API. Svix doesn't bill you for\nmessages not actually sent, so using this API doesn't save money.\nIf unsure, please ask Svix support before using this API.",
"operationId": "v1.message.precheck",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessagePrecheckIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessagePrecheckOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.message.precheck(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n eventType: \"user.signup\",\n channels: [\"project_123\", \"group_2\"],\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.message.precheck(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n eventType: \"user.signup\",\n channels: [\"project_123\", \"group_2\"],\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message.precheck(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n MessagePrecheckIn(\n event_type=\"user.signup\",\n channels=[\n \"project_123\",\n \"group_2\",\n ],\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message.precheck(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n MessagePrecheckIn(\n event_type=\"user.signup\",\n channels=[\n \"project_123\",\n \"group_2\",\n ],\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Message.Precheck(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\tMessagePrecheckIn{EventType: \"user.signup\", Channels: []string{\"project_123\", \"group_2\"}},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.message.precheck(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n MessagePrecheckIn(eventType = \"user.signup\", channels = setOf(\"project_123\", \"group_2\")),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessage()\n .precheck(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new MessagePrecheckIn()\n .eventType(\"user.signup\")\n .channels(Set.of(\"project_123\", \"group_2\")));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .message\n .precheck(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {eventType: \"user.signup\", channels: [\"project_123\", \"group_2\"]})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message()\n .precheck(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n MessagePrecheckIn {\n event_type: \"user.signup\".to_string(),\n channels: Some(vec![\"project_123\".to_string(), \"group_2\".to_string()]),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Message.Precheck(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new MessagePrecheckIn { EventType = \"user.signup\", Channels = [\"project_123\", \"group_2\"] }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->message->precheck(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n MessagePrecheckIn::create(\n eventType: \"user.signup\"\n )\n ->withChannels([\"project_123\",\"group_2\"])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message precheck \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" '{\n \"channels\": [\n \"project_123\",\n \"group_2\"\n ],\n \"eventType\": \"user.signup\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/msg/precheck/active' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"channels\": [\n \"project_123\",\n \"group_2\"\n ],\n \"eventType\": \"user.signup\"\n }'"
}
]
}
},
"/api/v1/app/{app_id}/msg/{msg_id}": {
"get": {
"tags": [
"Message"
],
"summary": "Get Message",
"description": "Get a message by its ID or eventID.",
"operationId": "v1.message.get",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "msg_id",
"description": "The Message's ID or UID.",
"required": true,
"schema": {
"description": "The Message's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "query",
"name": "with_content",
"description": "When `true` message payloads are included in the response.",
"schema": {
"description": "When `true` message payloads are included in the response.",
"default": true,
"type": "boolean"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.message.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.message.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Message.Get(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.message.get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response =\n svix.getMessage().get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.message.get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message()\n .get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\".to_string(),\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Message.Get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->message->get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message get \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/msg/msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}": {
"get": {
"tags": [
"Message Attempt"
],
"summary": "Get Attempt",
"description": "`msg_id`: Use a message id or a message `eventId`",
"operationId": "v1.message-attempt.get",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "msg_id",
"description": "The Message's ID or UID.",
"required": true,
"schema": {
"description": "The Message's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "attempt_id",
"description": "The MessageAttempt's ID.",
"required": true,
"schema": {
"description": "The MessageAttempt's ID.",
"type": "string",
"maxLength": 33,
"minLength": 33,
"pattern": "^atmpt_[A-Za-z0-9]{27}$",
"example": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageAttemptOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.messageAttempt.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.messageAttempt.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message_attempt.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message_attempt.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.MessageAttempt.Get(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n\t\"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.messageAttempt.get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessageAttempt()\n .get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .message_attempt\n .get(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\", \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message_attempt()\n .get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\".to_string(),\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.MessageAttempt.Get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->messageAttempt->get(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message-attempt get \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\" \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/msg/msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f/attempt/atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/msg/{msg_id}/attempt/{attempt_id}/content": {
"delete": {
"tags": [
"Message Attempt"
],
"summary": "Delete attempt response body",
"description": "Deletes the given attempt's response body.\n\nUseful when an endpoint accidentally returned sensitive content.\nThe message can't be replayed or resent once its payload has been deleted or expired.",
"operationId": "v1.message-attempt.expunge-content",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "msg_id",
"description": "The Message's ID or UID.",
"required": true,
"schema": {
"description": "The Message's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "attempt_id",
"description": "The MessageAttempt's ID.",
"required": true,
"schema": {
"description": "The MessageAttempt's ID.",
"type": "string",
"maxLength": 33,
"minLength": 33,
"pattern": "^atmpt_[A-Za-z0-9]{27}$",
"example": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.messageAttempt.expungeContent(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.messageAttempt.expungeContent(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.message_attempt.expunge_content(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.message_attempt.expunge_content(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.MessageAttempt.ExpungeContent(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n\t\"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.messageAttempt.expungeContent(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getMessageAttempt()\n .expungeContent(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .message_attempt\n .expunge_content(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.message_attempt()\n .expunge_content(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\".to_string(),\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.MessageAttempt.ExpungeContent(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->messageAttempt->expungeContent(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message-attempt expunge-content \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\" \"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'DELETE' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/msg/msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f/attempt/atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2/content' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
}
},
"/api/v1/app/{app_id}/msg/{msg_id}/content": {
"delete": {
"tags": [
"Message"
],
"summary": "Delete message payload",
"description": "Delete the given message's payload.\n\nUseful in cases when a message was accidentally sent with sensitive content.\nThe message can't be replayed or resent once its payload has been deleted or expired.",
"operationId": "v1.message.expunge-content",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "msg_id",
"description": "The Message's ID or UID.",
"required": true,
"schema": {
"description": "The Message's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.message.expungeContent(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.message.expungeContent(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.message.expunge_content(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.message.expunge_content(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Message.ExpungeContent(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.message.expungeContent(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getMessage()\n .expungeContent(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.message.expunge_content(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.message()\n .expunge_content(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Message.ExpungeContent(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->message->expungeContent(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message expunge-content \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'DELETE' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/msg/msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f/content' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
}
},
"/api/v1/app/{app_id}/msg/{msg_id}/endpoint": {
"get": {
"tags": [
"Message Attempt"
],
"summary": "List Attempted Destinations",
"description": "List endpoints attempted by a given message.\n\nAdditionally includes metadata about the latest message attempt.\nBy default, endpoints are listed in ascending order by ID.",
"operationId": "v1.message-attempt.list-attempted-destinations",
"parameters": [
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 30,
"minLength": 30,
"pattern": "^ep_[A-Za-z0-9]{27}$",
"nullable": true,
"example": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "form"
},
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "msg_id",
"description": "The Message's ID or UID.",
"required": true,
"schema": {
"description": "The Message's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_MessageEndpointOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.messageAttempt.listAttemptedDestinations(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.messageAttempt.listAttemptedDestinations(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message_attempt.list_attempted_destinations(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message_attempt.list_attempted_destinations(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.MessageAttempt.ListAttemptedDestinations(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.messageAttempt.listAttemptedDestinations(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessageAttempt()\n .listAttemptedDestinations(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .message_attempt\n .list_attempted_destinations(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message_attempt()\n .list_attempted_destinations(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\".to_string(),\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.MessageAttempt.ListAttemptedDestinations(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->messageAttempt->listAttemptedDestinations(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message-attempt list-attempted-destinations \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/msg/msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f/endpoint' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/resend": {
"post": {
"tags": [
"Message Attempt"
],
"summary": "Resend Webhook",
"description": "Resend a message to the specified endpoint.",
"operationId": "v1.message-attempt.resend",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "msg_id",
"description": "The Message's ID or UID.",
"required": true,
"schema": {
"description": "The Message's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"202": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.messageAttempt.resend(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.messageAttempt.resend(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message_attempt.resend(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message_attempt.resend(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.MessageAttempt.Resend(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.messageAttempt.resend(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessageAttempt()\n .resend(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .message_attempt\n .resend(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\", \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message_attempt()\n .resend(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\".to_string(),\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.MessageAttempt.Resend(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->messageAttempt->resend(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message-attempt resend \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f\" \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/msg/msg_33ZHzkmDazsPr4mDUsdzXJrGQ1f/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/resend' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/poller/{sink_id}": {
"get": {
"tags": [
"Message"
],
"summary": "Poller Poll",
"description": "Reads the stream of created messages for an application, filtered on the Sink's event types and Channels.",
"operationId": "v1.message.poller.poll",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "event_type",
"description": "Filters messages sent with this event type (optional).",
"schema": {
"description": "Filters messages sent with this event type (optional).",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"nullable": true,
"example": "user.signup"
},
"style": "form"
},
{
"in": "query",
"name": "channel",
"description": "Filters messages sent with this channel (optional).",
"schema": {
"description": "Filters messages sent with this channel (optional).",
"type": "string",
"maxLength": 128,
"pattern": "^[a-zA-Z0-9\\-_.:]+$",
"nullable": true,
"example": "project_1337"
},
"style": "form"
},
{
"in": "query",
"name": "after",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PollingEndpointOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.message.poller.poll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.message.poller.poll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message.poller.poll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message.poller.poll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Message.Poller.Poll(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.message.poller.poll(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessage()\n .getPoller()\n .poll(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"sink_31Dc11sPYY9aLDkwPuGMa\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.message.poller.poll(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message()\n .poller()\n .poll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Message.Poller.Poll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->message->poller->poll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message poller poll \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"sink_31Dc11sPYY9aLDkwPuGMa\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/poller/sink_31Dc11sPYY9aLDkwPuGMa' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id}": {
"get": {
"tags": [
"Message"
],
"summary": "Poller Consumer Poll",
"description": "Reads the stream of created messages for an application, filtered on the Sink's event types and\nChannels, using server-managed iterator tracking.",
"operationId": "v1.message.poller.consumer-poll",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "consumer_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PollingEndpointOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.message.poller.consumerPoll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.message.poller.consumerPoll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message.poller.consumer_poll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message.poller.consumer_poll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Message.Poller.ConsumerPoll(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n\t\"consumer_id\",\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.message.poller.consumerPoll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\",\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessage()\n .getPoller()\n .consumerPoll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"sink_31Dc11sPYY9aLDkwPuGMa\", \"consumer_id\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .message\n .poller\n .consumer_poll(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", \"sink_31Dc11sPYY9aLDkwPuGMa\", \"consumer_id\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message()\n .poller()\n .consumer_poll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n \"consumer_id\".to_string(),\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Message.Poller.ConsumerPoll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->message->poller->consumerPoll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message poller consumer-poll \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"sink_31Dc11sPYY9aLDkwPuGMa\" \"consumer_id\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/poller/sink_31Dc11sPYY9aLDkwPuGMa/consumer/consumer_id' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id}/seek": {
"post": {
"tags": [
"Message"
],
"summary": "Poller Consumer Seek",
"description": "Sets the starting offset for the consumer of a polling endpoint.",
"operationId": "v1.message.poller.consumer-seek",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "consumer_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PollingEndpointConsumerSeekIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PollingEndpointConsumerSeekOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.message.poller.consumerSeek(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\",\n {\n after: new Date(\"2025-10-02T20:28:42+00:00\"),\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.message.poller.consumerSeek(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\",\n {\n after: new Date(\"2025-10-02T20:28:42+00:00\"),\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.message.poller.consumer_seek(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\",\n PollingEndpointConsumerSeekIn(\n after=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.message.poller.consumer_seek(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\",\n PollingEndpointConsumerSeekIn(\n after=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Message.Poller.ConsumerSeek(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n\t\"consumer_id\",\n\tPollingEndpointConsumerSeekIn{After: time.Date(2025, 10, 2, 20, 28, 42, 0, time.UTC)},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.message.poller.consumerSeek(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\",\n PollingEndpointConsumerSeekIn(after = Instant.parse(\"2025-10-02T20:28:42+00:00\")),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getMessage()\n .getPoller()\n .consumerSeek(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\",\n new PollingEndpointConsumerSeekIn()\n .after(OffsetDateTime.parse(\"2025-10-02T20:28:42+00:00\")));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .message\n .poller\n .consumer_seek(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\",\n {after: \"2025-10-02T20:28:42+00:00\"}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .message()\n .poller()\n .consumer_seek(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n \"consumer_id\".to_string(),\n PollingEndpointConsumerSeekIn {\n after: \"2025-10-02T20:28:42+00:00\".to_string(),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Message.Poller.ConsumerSeek(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\",\n new PollingEndpointConsumerSeekIn { After = DateTime.Parse(\"2025-10-02T20:28:42+00:00\") }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->message->poller->consumerSeek(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n \"consumer_id\",\n PollingEndpointConsumerSeekIn::create(\n after: new DateTimeImmutable(\"2025-10-02T20:28:42+00:00\")\n )\n\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix message poller consumer-seek \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" \"sink_31Dc11sPYY9aLDkwPuGMa\" \"consumer_id\" '{\n \"after\": \"2025-10-02T20:28:42+00:00\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/poller/sink_31Dc11sPYY9aLDkwPuGMa/consumer/consumer_id/seek' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"after\": \"2025-10-02T20:28:42+00:00\"\n }'"
}
]
}
},
"/api/v1/auth/app-portal-access/{app_id}": {
"post": {
"tags": [
"Authentication"
],
"summary": "Get Consumer App Portal Access",
"description": "Use this function to get magic links (and authentication codes) for connecting your users to the Consumer Application Portal.",
"operationId": "v1.authentication.app-portal-access",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPortalAccessIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPortalAccessOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.authentication.appPortalAccess(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n {\n application: {\n name: \"My first application\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n metadata: {},\n },\n readOnly: true,\n capabilities: [],\n featureFlags: [],\n expiry: 1,\n sessionId: \"user_1FB8\",\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.authentication.appPortalAccess(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n {\n application: {\n name: \"My first application\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n metadata: {},\n },\n readOnly: true,\n capabilities: [],\n featureFlags: [],\n expiry: 1,\n sessionId: \"user_1FB8\",\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.authentication.app_portal_access(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n AppPortalAccessIn(\n application=ApplicationIn(\n name=\"My first application\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n metadata={},\n ),\n read_only=True,\n capabilities=[],\n feature_flags=[],\n expiry=1,\n session_id=\"user_1FB8\",\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.authentication.app_portal_access(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n AppPortalAccessIn(\n application=ApplicationIn(\n name=\"My first application\",\n rate_limit=1,\n throttle_rate=1,\n uid=\"unique-identifier\",\n metadata={},\n ),\n read_only=True,\n capabilities=[],\n feature_flags=[],\n expiry=1,\n session_id=\"user_1FB8\",\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Authentication.AppPortalAccess(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\tAppPortalAccessIn{\n\t\tApplication: ptr(\n\t\t\tApplicationIn{\n\t\t\t\tName: \"My first application\",\n\t\t\t\tRateLimit: ptr(uint16(1)),\n\t\t\t\tThrottleRate: ptr(uint16(1)),\n\t\t\t\tUid: ptr(\"unique-identifier\"),\n\t\t\t\tMetadata: nil,\n\t\t\t},\n\t\t),\n\t\tReadOnly: ptr(true),\n\t\tCapabilities: []AppPortalCapability{\"ViewBase\", \"ViewEndpointSecret\"},\n\t\tFeatureFlags: []string{},\n\t\tExpiry: ptr(uint64(1)),\n\t\tSessionId: ptr(\"user_1FB8\"),\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.authentication.appPortalAccess(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n AppPortalAccessIn(\n application =\n ApplicationIn(\n name = \"My first application\",\n rateLimit = 1u,\n throttleRate = 1u,\n uid = \"unique-identifier\",\n metadata = mapOf(),\n ),\n readOnly = true,\n capabilities =\n setOf(AppPortalCapability.VIEW_BASE, AppPortalCapability.VIEW_ENDPOINT_SECRET),\n featureFlags = setOf(),\n expiry = 1u,\n sessionId = \"user_1FB8\",\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getAuthentication()\n .appPortalAccess(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new AppPortalAccessIn()\n .application(new ApplicationIn()\n .name(\"My first application\")\n .rateLimit(1L)\n .throttleRate(1L)\n .uid(\"unique-identifier\")\n .metadata(Map.of()))\n .readOnly(true)\n .capabilities(\n Set.of(AppPortalCapability.VIEW_BASE, AppPortalCapability.VIEW_ENDPOINT_SECRET))\n .featureFlags(Set.of())\n .expiry(1L)\n .sessionId(\"user_1FB8\"));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .authentication\n .app_portal_access(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n {\n application: {\n name: \"My first application\",\n rateLimit: 1,\n throttleRate: 1,\n uid: \"unique-identifier\",\n metadata: {}\n },\n readOnly: true,\n capabilities: [\"ViewBase\", \"ViewEndpointSecret\"],\n featureFlags: [],\n expiry: 1,\n sessionId: \"user_1FB8\"\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .authentication()\n .app_portal_access(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n AppPortalAccessIn {\n application: Some(ApplicationIn {\n name: \"My first application\".to_string(),\n rate_limit: Some(1),\n throttle_rate: Some(1),\n uid: Some(\"unique-identifier\".to_string()),\n metadata: Some(HashMap::new()),\n }),\n read_only: Some(true),\n capabilities: Some(vec![]),\n feature_flags: Some(vec![]),\n expiry: Some(1),\n session_id: Some(\"user_1FB8\".to_string()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Authentication.AppPortalAccess(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new AppPortalAccessIn\n {\n Application = new ApplicationIn\n {\n Name = \"My first application\",\n RateLimit = 1,\n ThrottleRate = 1,\n Uid = \"unique-identifier\",\n Metadata = [],\n },\n ReadOnly = true,\n Capabilities = [AppPortalCapability.ViewBase, AppPortalCapability.ViewEndpointSecret],\n FeatureFlags = [],\n Expiry = 1,\n SessionId = \"user_1FB8\",\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->authentication->appPortalAccess(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n AppPortalAccessIn::create()\n ->withApplication(ApplicationIn::create(\n name: \"My first application\"\n )\n ->withRateLimit(1)\n ->withThrottleRate(1)\n ->withUid(\"unique-identifier\")\n ->withMetadata([]))\n ->withReadOnly(true)\n ->withCapabilities([])\n ->withFeatureFlags([])\n ->withExpiry(1)\n ->withSessionId(\"user_1FB8\")\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix authentication app-portal-access \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" '{\n \"application\": {\n \"metadata\": {},\n \"name\": \"My first application\",\n \"rateLimit\": 1,\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\"\n },\n \"capabilities\": [\n \"ViewBase\",\n \"ViewEndpointSecret\"\n ],\n \"expiry\": 1,\n \"featureFlags\": [],\n \"readOnly\": true,\n \"sessionId\": \"user_1FB8\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/auth/app-portal-access/app_1srOrx2ZWZBpBUvZwXKQmoEYga2' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"application\": {\n \"metadata\": {},\n \"name\": \"My first application\",\n \"rateLimit\": 1,\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\"\n },\n \"capabilities\": [\n \"ViewBase\",\n \"ViewEndpointSecret\"\n ],\n \"expiry\": 1,\n \"featureFlags\": [],\n \"readOnly\": true,\n \"sessionId\": \"user_1FB8\"\n }'"
}
]
}
},
"/api/v1/auth/app/{app_id}/expire-all": {
"post": {
"tags": [
"Authentication"
],
"summary": "Expire All",
"description": "Expire all of the tokens associated with a specific application.",
"operationId": "v1.authentication.expire-all",
"parameters": [
{
"in": "path",
"name": "app_id",
"description": "The Application's ID or UID.",
"required": true,
"schema": {
"description": "The Application's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationTokenExpireIn"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.authentication.expireAll(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n expiry: 60,\n sessionIds: [],\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.authentication.expireAll(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n expiry: 60,\n sessionIds: [],\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.authentication.expire_all(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n ApplicationTokenExpireIn(\n expiry=60,\n session_ids=[],\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.authentication.expire_all(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n ApplicationTokenExpireIn(\n expiry=60,\n session_ids=[],\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Authentication.ExpireAll(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\tApplicationTokenExpireIn{Expiry: ptr(int64(60)), SessionIds: []string{}},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.authentication.expireAll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n ApplicationTokenExpireIn(expiry = 60, sessionIds = listOf()),\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getAuthentication()\n .expireAll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new ApplicationTokenExpireIn().expiry(60L).sessionIds(List.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.authentication.expire_all(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {expiry: 60, sessionIds: []})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.authentication()\n .expire_all(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n ApplicationTokenExpireIn {\n expiry: Some(60),\n session_ids: Some(vec![]),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Authentication.ExpireAll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new ApplicationTokenExpireIn { Expiry = 60, SessionIds = [] }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->authentication->expireAll(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n ApplicationTokenExpireIn::create()\n ->withExpiry(60)\n ->withSessionIds([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix authentication expire-all \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\" '{\n \"expiry\": 60,\n \"sessionIds\": []\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/auth/app/app_1srOrx2ZWZBpBUvZwXKQmoEYga2/expire-all' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"expiry\": 60,\n \"sessionIds\": []\n }'"
}
]
}
},
"/api/v1/auth/logout": {
"post": {
"tags": [
"Authentication"
],
"summary": "Logout",
"description": "Logout an app token.\n\nTrying to log out other tokens will fail.",
"operationId": "v1.authentication.logout",
"parameters": [
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.authentication.logout();"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.authentication.logout();"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.authentication.logout()"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.authentication.logout()"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Authentication.Logout(ctx, nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.authentication\n .logout()"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getAuthentication().logout();"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.authentication.logout"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.authentication().logout(None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Authentication.Logout();"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->authentication->logout();"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix authentication logout"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/auth/logout' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
}
},
"/api/v1/auth/stream-logout": {
"post": {
"tags": [
"Stream Authentication"
],
"summary": "Stream Logout",
"description": "Logout a stream token.\n\nTrying to log out other tokens will fail.",
"operationId": "v1.authentication.stream-logout",
"parameters": [
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.authentication.streamLogout();"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.authentication.streamLogout();"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.authentication.stream_logout()"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.authentication.stream_logout()"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Authentication.StreamLogout(ctx, nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.authentication\n .streamLogout()"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getAuthentication().streamLogout();"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.authentication.stream_logout"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.authentication().stream_logout(None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Authentication.StreamLogout();"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->authentication->streamLogout();"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix authentication stream-logout"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/auth/stream-logout' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
}
},
"/api/v1/auth/stream-portal-access/{stream_id}": {
"post": {
"tags": [
"Stream Authentication"
],
"summary": "Get Stream Portal Access",
"description": "Use this function to get magic links (and authentication codes) for connecting your users to the Stream Consumer Portal.",
"operationId": "v1.authentication.stream-portal-access",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamPortalAccessIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPortalAccessOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.authentication.streamPortalAccess(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n {\n featureFlags: [],\n expiry: 1,\n sessionId: \"user_1FB8\",\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.authentication.streamPortalAccess(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n {\n featureFlags: [],\n expiry: 1,\n sessionId: \"user_1FB8\",\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.authentication.stream_portal_access(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamPortalAccessIn(\n feature_flags=[],\n expiry=1,\n session_id=\"user_1FB8\",\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.authentication.stream_portal_access(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamPortalAccessIn(\n feature_flags=[],\n expiry=1,\n session_id=\"user_1FB8\",\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Authentication.StreamPortalAccess(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\tStreamPortalAccessIn{\n\t\tFeatureFlags: []string{},\n\t\tExpiry: ptr(uint64(1)),\n\t\tSessionId: ptr(\"user_1FB8\"),\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.authentication.streamPortalAccess(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamPortalAccessIn(featureFlags = setOf(), expiry = 1u, sessionId = \"user_1FB8\"),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getAuthentication()\n .streamPortalAccess(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n new StreamPortalAccessIn().featureFlags(Set.of()).expiry(1L).sessionId(\"user_1FB8\"));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .authentication\n .stream_portal_access(\"strm_31Dc0DD72P5AddYUguyBd\", {featureFlags: [], expiry: 1, sessionId: \"user_1FB8\"})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .authentication()\n .stream_portal_access(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n StreamPortalAccessIn {\n feature_flags: Some(vec![]),\n expiry: Some(1),\n session_id: Some(\"user_1FB8\".to_string()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Authentication.StreamPortalAccess(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n new StreamPortalAccessIn\n {\n FeatureFlags = [],\n Expiry = 1,\n SessionId = \"user_1FB8\",\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->authentication->streamPortalAccess(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamPortalAccessIn::create()\n ->withFeatureFlags([])\n ->withExpiry(1)\n ->withSessionId(\"user_1FB8\")\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix authentication stream-portal-access \"strm_31Dc0DD72P5AddYUguyBd\" '{\n \"expiry\": 1,\n \"featureFlags\": [],\n \"sessionId\": \"user_1FB8\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/auth/stream-portal-access/strm_31Dc0DD72P5AddYUguyBd' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"expiry\": 1,\n \"featureFlags\": [],\n \"sessionId\": \"user_1FB8\"\n }'"
}
]
}
},
"/api/v1/auth/stream/{stream_id}/expire-all": {
"post": {
"tags": [
"Stream Authentication"
],
"summary": "Stream Expire All",
"description": "Expire all of the tokens associated with a specific stream.",
"operationId": "v1.authentication.stream-expire-all",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamTokenExpireIn"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.authentication.streamExpireAll(\"strm_31Dc0DD72P5AddYUguyBd\", {\n expiry: 60,\n sessionIds: [],\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.authentication.streamExpireAll(\"strm_31Dc0DD72P5AddYUguyBd\", {\n expiry: 60,\n sessionIds: [],\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.authentication.stream_expire_all(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamTokenExpireIn(\n expiry=60,\n session_ids=[],\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.authentication.stream_expire_all(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamTokenExpireIn(\n expiry=60,\n session_ids=[],\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Authentication.StreamExpireAll(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\tStreamTokenExpireIn{Expiry: ptr(int64(60)), SessionIds: []string{}},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.authentication.streamExpireAll(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamTokenExpireIn(expiry = 60, sessionIds = listOf()),\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getAuthentication()\n .streamExpireAll(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n new StreamTokenExpireIn().expiry(60L).sessionIds(List.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.authentication.stream_expire_all(\"strm_31Dc0DD72P5AddYUguyBd\", {expiry: 60, sessionIds: []})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.authentication()\n .stream_expire_all(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n StreamTokenExpireIn {\n expiry: Some(60),\n session_ids: Some(vec![]),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Authentication.StreamExpireAll(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n new StreamTokenExpireIn { Expiry = 60, SessionIds = [] }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->authentication->streamExpireAll(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamTokenExpireIn::create()\n ->withExpiry(60)\n ->withSessionIds([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix authentication stream-expire-all \"strm_31Dc0DD72P5AddYUguyBd\" '{\n \"expiry\": 60,\n \"sessionIds\": []\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/auth/stream/strm_31Dc0DD72P5AddYUguyBd/expire-all' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"expiry\": 60,\n \"sessionIds\": []\n }'"
}
]
}
},
"/api/v1/auth/stream/{stream_id}/sink/{sink_id}/poller/token": {
"get": {
"tags": [
"Stream Authentication"
],
"summary": "Get Poller Token",
"description": "Get the current auth token for the stream poller.",
"operationId": "v1.authentication.get-stream-poller-token",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiTokenOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.authentication.getStreamPollerToken(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.authentication.getStreamPollerToken(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.authentication.get_stream_poller_token(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.authentication.get_stream_poller_token(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Authentication.GetStreamPollerToken(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.authentication.getStreamPollerToken(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getAuthentication()\n .getStreamPollerToken(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.authentication.get_stream_poller_token(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .authentication()\n .get_stream_poller_token(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Authentication.GetStreamPollerToken(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->authentication->getStreamPollerToken(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix authentication get-stream-poller-token \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/auth/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa/poller/token' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/auth/stream/{stream_id}/sink/{sink_id}/poller/token/rotate": {
"post": {
"tags": [
"Stream Authentication"
],
"summary": "Rotate Poller Token",
"description": "Create a new auth token for the stream poller API.",
"operationId": "v1.authentication.rotate-stream-poller-token",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RotatePollerTokenIn"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiTokenOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.authentication.rotateStreamPollerToken(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n expiry: 1,\n oldTokenExpiry: 1,\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.authentication.rotateStreamPollerToken(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n expiry: 1,\n oldTokenExpiry: 1,\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.authentication.rotate_stream_poller_token(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n RotatePollerTokenIn(\n expiry=1,\n old_token_expiry=1,\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.authentication.rotate_stream_poller_token(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n RotatePollerTokenIn(\n expiry=1,\n old_token_expiry=1,\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Authentication.RotateStreamPollerToken(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n\tRotatePollerTokenIn{Expiry: ptr(int64(1)), OldTokenExpiry: ptr(int64(1))},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.authentication.rotateStreamPollerToken(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n RotatePollerTokenIn(expiry = 1, oldTokenExpiry = 1),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getAuthentication()\n .rotateStreamPollerToken(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n new RotatePollerTokenIn().expiry(1L).oldTokenExpiry(1L));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .authentication\n .rotate_stream_poller_token(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {expiry: 1, oldTokenExpiry: 1}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .authentication()\n .rotate_stream_poller_token(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n RotatePollerTokenIn {\n expiry: Some(1),\n old_token_expiry: Some(1),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Authentication.RotateStreamPollerToken(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n new RotatePollerTokenIn { Expiry = 1, OldTokenExpiry = 1 }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->authentication->rotateStreamPollerToken(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n RotatePollerTokenIn::create()\n ->withExpiry(1)\n ->withOldTokenExpiry(1)\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix authentication rotate-stream-poller-token \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\" '{\n \"expiry\": 1,\n \"oldTokenExpiry\": 1\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/auth/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa/poller/token/rotate' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"expiry\": 1,\n \"oldTokenExpiry\": 1\n }'"
}
]
}
},
"/api/v1/background-task": {
"get": {
"tags": [
"Background Task"
],
"summary": "List Background Tasks",
"description": "List background tasks executed in the past 90 days.",
"operationId": "v1.background-task.list",
"parameters": [
{
"in": "query",
"name": "status",
"description": "Filter the response based on the status.",
"schema": {
"description": "Filter the response based on the status.",
"$ref": "#/components/schemas/BackgroundTaskStatus",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "task",
"description": "Filter the response based on the type.",
"schema": {
"description": "Filter the response based on the type.",
"$ref": "#/components/schemas/BackgroundTaskType",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 33,
"minLength": 33,
"pattern": "^qtask_[A-Za-z0-9]{27}$",
"nullable": true,
"example": "qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "form"
},
{
"in": "query",
"name": "order",
"description": "The sorting order of the returned items",
"schema": {
"description": "The sorting order of the returned items",
"$ref": "#/components/schemas/Ordering",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_BackgroundTaskOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.backgroundTask.list();"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.backgroundTask.list();"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.background_task.list()"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.background_task.list()"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.BackgroundTask.List(ctx, nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.backgroundTask.list()"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getBackgroundTask().list();"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.background_task.list"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.background_task().list(None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.BackgroundTask.List();"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->backgroundTask->list();"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix background-task list"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/background-task' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/background-task/{task_id}": {
"get": {
"tags": [
"Background Task"
],
"summary": "Get Background Task",
"description": "Get a background task by ID.",
"operationId": "v1.background-task.get",
"parameters": [
{
"in": "path",
"name": "task_id",
"description": "The QueueBackgroundTask's ID.",
"required": true,
"schema": {
"description": "The QueueBackgroundTask's ID.",
"type": "string",
"maxLength": 33,
"minLength": 33,
"pattern": "^qtask_[A-Za-z0-9]{27}$",
"example": "qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackgroundTaskOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.backgroundTask.get(\"qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.backgroundTask.get(\"qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.background_task.get(\n \"qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.background_task.get(\n \"qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.BackgroundTask.Get(ctx, \"qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.backgroundTask.get(\"qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getBackgroundTask().get(\"qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.background_task.get(\"qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .background_task()\n .get(\"qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string())\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.BackgroundTask.Get(\"qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->backgroundTask->get(\n \"qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix background-task get \"qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/background-task/qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/connector": {
"get": {
"tags": [
"Connector"
],
"summary": "List Connectors",
"description": "List all connectors for an application.",
"operationId": "v1.connector.list",
"parameters": [
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 34,
"minLength": 34,
"pattern": "^trtmpl_[A-Za-z0-9]{27}$",
"nullable": true,
"example": "trtmpl_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "form"
},
{
"in": "query",
"name": "order",
"description": "The sorting order of the returned items",
"schema": {
"description": "The sorting order of the returned items",
"$ref": "#/components/schemas/Ordering",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "product_type",
"schema": {
"$ref": "#/components/schemas/ConnectorProduct",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_ConnectorOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.connector.list();"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.connector.list();"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.connector.list()"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.connector.list()"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Connector.List(ctx, nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.connector.list()"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getConnector().list();"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.connector.list"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.connector().list(None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Connector.List();"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->connector->list();"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix connector list"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/connector' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"post": {
"tags": [
"Connector"
],
"summary": "Create Connector",
"description": "Create a new connector.",
"operationId": "v1.connector.create",
"parameters": [
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorIn"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.connector.create({\n name: \"My first connector\",\n uid: \"unique-identifier\",\n logo: \"https://example.com/logo.png\",\n description: \"Example connector description\",\n kind: ConnectorKind.Custom,\n instructions: \"Markdown-formatted instructions\",\n allowedEventTypes: [\"user.signup\", \"user.deleted\"],\n transformation: \"function handler(webhook) { /* ... */ }\",\n featureFlags: [],\n productType: ConnectorProduct.Dispatch,\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.connector.create({\n name: \"My first connector\",\n uid: \"unique-identifier\",\n logo: \"https://example.com/logo.png\",\n description: \"Example connector description\",\n kind: ConnectorKind.Custom,\n instructions: \"Markdown-formatted instructions\",\n allowedEventTypes: [\"user.signup\", \"user.deleted\"],\n transformation: \"function handler(webhook) { /* ... */ }\",\n featureFlags: [],\n productType: ConnectorProduct.Dispatch,\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.connector.create(\n ConnectorIn(\n name=\"My first connector\",\n uid=\"unique-identifier\",\n logo=\"https://example.com/logo.png\",\n description=\"Example connector description\",\n kind=ConnectorKind.CUSTOM,\n instructions=\"Markdown-formatted instructions\",\n allowed_event_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n transformation=\"function handler(webhook) { /* ... */ }\",\n feature_flags=[],\n product_type=ConnectorProduct.DISPATCH,\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.connector.create(\n ConnectorIn(\n name=\"My first connector\",\n uid=\"unique-identifier\",\n logo=\"https://example.com/logo.png\",\n description=\"Example connector description\",\n kind=ConnectorKind.CUSTOM,\n instructions=\"Markdown-formatted instructions\",\n allowed_event_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n transformation=\"function handler(webhook) { /* ... */ }\",\n feature_flags=[],\n product_type=ConnectorProduct.DISPATCH,\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Connector.Create(\n\tctx,\n\tConnectorIn{\n\t\tName: \"My first connector\",\n\t\tUid: ptr(\"unique-identifier\"),\n\t\tLogo: ptr(\"https://example.com/logo.png\"),\n\t\tDescription: ptr(\"Example connector description\"),\n\t\tKind: ptr(CONNECTORKIND_CUSTOM),\n\t\tInstructions: ptr(\"Markdown-formatted instructions\"),\n\t\tAllowedEventTypes: []string{\"user.signup\", \"user.deleted\"},\n\t\tTransformation: \"function handler(webhook) { /* ... */ }\",\n\t\tFeatureFlags: []string{},\n\t\tProductType: ptr(CONNECTORPRODUCT_DISPATCH),\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.connector.create(\n ConnectorIn(\n name = \"My first connector\",\n uid = \"unique-identifier\",\n logo = \"https://example.com/logo.png\",\n description = \"Example connector description\",\n kind = ConnectorKind.CUSTOM,\n instructions = \"Markdown-formatted instructions\",\n allowedEventTypes = setOf(\"user.signup\", \"user.deleted\"),\n transformation = \"function handler(webhook) { /* ... */ }\",\n featureFlags = setOf(),\n productType = ConnectorProduct.DISPATCH,\n )\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getConnector()\n .create(new ConnectorIn()\n .name(\"My first connector\")\n .uid(\"unique-identifier\")\n .logo(URI.create(\"https://example.com/logo.png\"))\n .description(\"Example connector description\")\n .kind(ConnectorKind.CUSTOM)\n .instructions(\"Markdown-formatted instructions\")\n .allowedEventTypes(Set.of(\"user.signup\", \"user.deleted\"))\n .transformation(\"function handler(webhook) { /* ... */ }\")\n .featureFlags(Set.of())\n .productType(ConnectorProduct.DISPATCH));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .connector\n .create(\n {\n name: \"My first connector\",\n uid: \"unique-identifier\",\n logo: \"https://example.com/logo.png\",\n description: \"Example connector description\",\n kind: ConnectorKind::CUSTOM,\n instructions: \"Markdown-formatted instructions\",\n allowedEventTypes: [\"user.signup\", \"user.deleted\"],\n transformation: \"function handler(webhook) { /* ... */ }\",\n featureFlags: [],\n productType: ConnectorProduct::DISPATCH\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .connector()\n .create(\n ConnectorIn {\n name: \"My first connector\".to_string(),\n uid: Some(\"unique-identifier\".to_string()),\n logo: Some(\"https://example.com/logo.png\".to_string()),\n description: Some(\"Example connector description\".to_string()),\n kind: Some(ConnectorKind::Custom),\n instructions: Some(\"Markdown-formatted instructions\".to_string()),\n allowed_event_types: Some(\n vec![\"user.signup\".to_string(), \"user.deleted\".to_string()],\n ),\n transformation: \"function handler(webhook) { /* ... */ }\".to_string(),\n feature_flags: Some(vec![]),\n product_type: Some(ConnectorProduct::Dispatch),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Connector.Create(\n new ConnectorIn\n {\n Name = \"My first connector\",\n Uid = \"unique-identifier\",\n Logo = \"https://example.com/logo.png\",\n Description = \"Example connector description\",\n Kind = ConnectorKind.Custom,\n Instructions = \"Markdown-formatted instructions\",\n AllowedEventTypes = [\"user.signup\", \"user.deleted\"],\n Transformation = \"function handler(webhook) { /* ... */ }\",\n FeatureFlags = [],\n ProductType = ConnectorProduct.Dispatch,\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->connector->create(\n ConnectorIn::create(\n name: \"My first connector\",\n transformation: \"function handler(webhook) { /* ... */ }\"\n )\n ->withUid(\"unique-identifier\")\n ->withLogo(\"https://example.com/logo.png\")\n ->withDescription(\"Example connector description\")\n ->withKind(ConnectorKind::CUSTOM)\n ->withInstructions(\"Markdown-formatted instructions\")\n ->withAllowedEventTypes([\"user.signup\",\"user.deleted\"])\n ->withFeatureFlags([])\n ->withProductType(ConnectorProduct::DISPATCH)\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix connector create '{\n \"allowedEventTypes\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"description\": \"Example connector description\",\n \"featureFlags\": [],\n \"instructions\": \"Markdown-formatted instructions\",\n \"kind\": \"Custom\",\n \"logo\": \"https://example.com/logo.png\",\n \"name\": \"My first connector\",\n \"productType\": \"Dispatch\",\n \"transformation\": \"function handler(webhook) { /* ... */ }\",\n \"uid\": \"unique-identifier\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/connector' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"allowedEventTypes\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"description\": \"Example connector description\",\n \"featureFlags\": [],\n \"instructions\": \"Markdown-formatted instructions\",\n \"kind\": \"Custom\",\n \"logo\": \"https://example.com/logo.png\",\n \"name\": \"My first connector\",\n \"productType\": \"Dispatch\",\n \"transformation\": \"function handler(webhook) { /* ... */ }\",\n \"uid\": \"unique-identifier\"\n }'"
}
]
}
},
"/api/v1/connector/{connector_id}": {
"get": {
"tags": [
"Connector"
],
"summary": "Get Connector",
"description": "Get a connector.",
"operationId": "v1.connector.get",
"parameters": [
{
"in": "path",
"name": "connector_id",
"description": "The Connector's ID or UID.",
"required": true,
"schema": {
"description": "The Connector's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.connector.get(\"connector_id\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.connector.get(\"connector_id\");"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.connector.get(\n \"connector_id\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.connector.get(\n \"connector_id\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Connector.Get(ctx, \"connector_id\")"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.connector.get(\"connector_id\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getConnector().get(\"connector_id\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.connector.get(\"connector_id\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.connector().get(\"connector_id\".to_string()).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Connector.Get(\"connector_id\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->connector->get(\n \"connector_id\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix connector get \"connector_id\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/connector/connector_id' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"put": {
"tags": [
"Connector"
],
"summary": "Update Connector",
"description": "Update a connector.",
"operationId": "v1.connector.update",
"parameters": [
{
"in": "path",
"name": "connector_id",
"description": "The Connector's ID or UID.",
"required": true,
"schema": {
"description": "The Connector's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorOut"
}
}
}
},
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.connector.update(\"connector_id\", {\n name: \"My first connector\",\n logo: \"https://example.com/logo.png\",\n description: \"Example connector description\",\n kind: ConnectorKind.Custom,\n instructions: \"Markdown-formatted instructions\",\n allowedEventTypes: [\"user.signup\", \"user.deleted\"],\n transformation: \"function handler(webhook) { /* ... */ }\",\n featureFlags: [\"cool-new-feature\"],\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.connector.update(\"connector_id\", {\n name: \"My first connector\",\n logo: \"https://example.com/logo.png\",\n description: \"Example connector description\",\n kind: ConnectorKind.Custom,\n instructions: \"Markdown-formatted instructions\",\n allowedEventTypes: [\"user.signup\", \"user.deleted\"],\n transformation: \"function handler(webhook) { /* ... */ }\",\n featureFlags: [\"cool-new-feature\"],\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.connector.update(\n \"connector_id\",\n ConnectorUpdate(\n name=\"My first connector\",\n logo=\"https://example.com/logo.png\",\n description=\"Example connector description\",\n kind=ConnectorKind.CUSTOM,\n instructions=\"Markdown-formatted instructions\",\n allowed_event_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n transformation=\"function handler(webhook) { /* ... */ }\",\n feature_flags=[\n \"cool-new-feature\",\n ],\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.connector.update(\n \"connector_id\",\n ConnectorUpdate(\n name=\"My first connector\",\n logo=\"https://example.com/logo.png\",\n description=\"Example connector description\",\n kind=ConnectorKind.CUSTOM,\n instructions=\"Markdown-formatted instructions\",\n allowed_event_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n transformation=\"function handler(webhook) { /* ... */ }\",\n feature_flags=[\n \"cool-new-feature\",\n ],\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Connector.Update(\n\tctx,\n\t\"connector_id\",\n\tConnectorUpdate{\n\t\tName: ptr(\"My first connector\"),\n\t\tLogo: ptr(\"https://example.com/logo.png\"),\n\t\tDescription: ptr(\"Example connector description\"),\n\t\tKind: ptr(CONNECTORKIND_CUSTOM),\n\t\tInstructions: ptr(\"Markdown-formatted instructions\"),\n\t\tAllowedEventTypes: []string{\"user.signup\", \"user.deleted\"},\n\t\tTransformation: \"function handler(webhook) { /* ... */ }\",\n\t\tFeatureFlags: []string{\"cool-new-feature\"},\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.connector.update(\n \"connector_id\",\n ConnectorUpdate(\n name = \"My first connector\",\n logo = \"https://example.com/logo.png\",\n description = \"Example connector description\",\n kind = ConnectorKind.CUSTOM,\n instructions = \"Markdown-formatted instructions\",\n allowedEventTypes = setOf(\"user.signup\", \"user.deleted\"),\n transformation = \"function handler(webhook) { /* ... */ }\",\n featureFlags = setOf(\"cool-new-feature\"),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getConnector()\n .update(\n \"connector_id\",\n new ConnectorUpdate()\n .name(\"My first connector\")\n .logo(URI.create(\"https://example.com/logo.png\"))\n .description(\"Example connector description\")\n .kind(ConnectorKind.CUSTOM)\n .instructions(\"Markdown-formatted instructions\")\n .allowedEventTypes(Set.of(\"user.signup\", \"user.deleted\"))\n .transformation(\"function handler(webhook) { /* ... */ }\")\n .featureFlags(Set.of(\"cool-new-feature\")));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .connector\n .update(\n \"connector_id\",\n {\n name: \"My first connector\",\n logo: \"https://example.com/logo.png\",\n description: \"Example connector description\",\n kind: ConnectorKind::CUSTOM,\n instructions: \"Markdown-formatted instructions\",\n allowedEventTypes: [\"user.signup\", \"user.deleted\"],\n transformation: \"function handler(webhook) { /* ... */ }\",\n featureFlags: [\"cool-new-feature\"]\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .connector()\n .update(\n \"connector_id\".to_string(),\n ConnectorUpdate {\n name: Some(\"My first connector\".to_string()),\n logo: Some(\"https://example.com/logo.png\".to_string()),\n description: Some(\"Example connector description\".to_string()),\n kind: Some(ConnectorKind::Custom),\n instructions: Some(\"Markdown-formatted instructions\".to_string()),\n allowed_event_types: Some(\n vec![\"user.signup\".to_string(), \"user.deleted\".to_string()],\n ),\n transformation: \"function handler(webhook) { /* ... */ }\".to_string(),\n feature_flags: Some(vec![\"cool-new-feature\".to_string()]),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Connector.Update(\n \"connector_id\",\n new ConnectorUpdate\n {\n Name = \"My first connector\",\n Logo = \"https://example.com/logo.png\",\n Description = \"Example connector description\",\n Kind = ConnectorKind.Custom,\n Instructions = \"Markdown-formatted instructions\",\n AllowedEventTypes = [\"user.signup\", \"user.deleted\"],\n Transformation = \"function handler(webhook) { /* ... */ }\",\n FeatureFlags = [\"cool-new-feature\"],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->connector->update(\n \"connector_id\",\n ConnectorUpdate::create(\n transformation: \"function handler(webhook) { /* ... */ }\"\n )\n ->withName(\"My first connector\")\n ->withLogo(\"https://example.com/logo.png\")\n ->withDescription(\"Example connector description\")\n ->withKind(ConnectorKind::CUSTOM)\n ->withInstructions(\"Markdown-formatted instructions\")\n ->withAllowedEventTypes([\"user.signup\",\"user.deleted\"])\n ->withFeatureFlags([\"cool-new-feature\"])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix connector update \"connector_id\" '{\n \"allowedEventTypes\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"description\": \"Example connector description\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"instructions\": \"Markdown-formatted instructions\",\n \"kind\": \"Custom\",\n \"logo\": \"https://example.com/logo.png\",\n \"name\": \"My first connector\",\n \"transformation\": \"function handler(webhook) { /* ... */ }\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PUT' \\\n 'https://api.eu.svix.com/api/v1/connector/connector_id' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"allowedEventTypes\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"description\": \"Example connector description\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"instructions\": \"Markdown-formatted instructions\",\n \"kind\": \"Custom\",\n \"logo\": \"https://example.com/logo.png\",\n \"name\": \"My first connector\",\n \"transformation\": \"function handler(webhook) { /* ... */ }\"\n }'"
}
]
},
"delete": {
"tags": [
"Connector"
],
"summary": "Delete Connector",
"description": "Delete a connector.",
"operationId": "v1.connector.delete",
"parameters": [
{
"in": "path",
"name": "connector_id",
"description": "The Connector's ID or UID.",
"required": true,
"schema": {
"description": "The Connector's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.connector.delete(\"connector_id\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.connector.delete(\"connector_id\");"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.connector.delete(\n \"connector_id\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.connector.delete(\n \"connector_id\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Connector.Delete(ctx, \"connector_id\")"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.connector.delete(\n \"connector_id\"\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getConnector().delete(\"connector_id\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.connector.delete(\"connector_id\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.connector().delete(\"connector_id\".to_string()).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Connector.Delete(\"connector_id\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->connector->delete(\n \"connector_id\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix connector delete \"connector_id\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'DELETE' \\\n 'https://api.eu.svix.com/api/v1/connector/connector_id' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
},
"patch": {
"tags": [
"Connector"
],
"summary": "Patch Connector",
"description": "Partially update a connector.",
"operationId": "v1.connector.patch",
"parameters": [
{
"in": "path",
"name": "connector_id",
"description": "The Connector's ID or UID.",
"required": true,
"schema": {
"description": "The Connector's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.connector.patch(\"connector_id\", {\n name: \"sample string\",\n logo: \"sample string\",\n description: \"sample string\",\n kind: ConnectorKind.Custom,\n instructions: \"sample string\",\n allowedEventTypes: [\"user.signup\", \"user.deleted\"],\n transformation: \"sample string\",\n featureFlags: [\"cool-new-feature\"],\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.connector.patch(\"connector_id\", {\n name: \"sample string\",\n logo: \"sample string\",\n description: \"sample string\",\n kind: ConnectorKind.Custom,\n instructions: \"sample string\",\n allowedEventTypes: [\"user.signup\", \"user.deleted\"],\n transformation: \"sample string\",\n featureFlags: [\"cool-new-feature\"],\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.connector.patch(\n \"connector_id\",\n ConnectorPatch(\n name=\"sample string\",\n logo=\"sample string\",\n description=\"sample string\",\n kind=ConnectorKind.CUSTOM,\n instructions=\"sample string\",\n allowed_event_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n transformation=\"sample string\",\n feature_flags=[\n \"cool-new-feature\",\n ],\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.connector.patch(\n \"connector_id\",\n ConnectorPatch(\n name=\"sample string\",\n logo=\"sample string\",\n description=\"sample string\",\n kind=ConnectorKind.CUSTOM,\n instructions=\"sample string\",\n allowed_event_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n transformation=\"sample string\",\n feature_flags=[\n \"cool-new-feature\",\n ],\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Connector.Patch(\n\tctx,\n\t\"connector_id\",\n\tConnectorPatch{\n\t\tName: ptr(\"sample string\"),\n\t\tLogo: NewNullable(\"sample string\"),\n\t\tDescription: ptr(\"sample string\"),\n\t\tKind: ptr(CONNECTORKIND_CUSTOM),\n\t\tInstructions: ptr(\"sample string\"),\n\t\tAllowedEventTypes: NewNullable([]string{\"user.signup\", \"user.deleted\"}),\n\t\tTransformation: ptr(\"sample string\"),\n\t\tFeatureFlags: NewNullable([]string{\"cool-new-feature\"}),\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.connector.patch(\n \"connector_id\",\n ConnectorPatch(\n name = \"sample string\",\n logo = MaybeUnset.Present(\"https://example.com/\"),\n description = \"sample string\",\n kind = ConnectorKind.CUSTOM,\n instructions = \"sample string\",\n allowedEventTypes = MaybeUnset.Present(setOf(\"user.signup\", \"user.deleted\")),\n transformation = \"sample string\",\n featureFlags = MaybeUnset.Present(setOf(\"cool-new-feature\")),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getConnector()\n .patch(\n \"connector_id\",\n new ConnectorPatch()\n .name(\"sample string\")\n .logo(URI.create(\"https://example.com/\"))\n .description(\"sample string\")\n .kind(ConnectorKind.CUSTOM)\n .instructions(\"sample string\")\n .allowedEventTypes(Set.of(\"user.signup\", \"user.deleted\"))\n .transformation(\"sample string\")\n .featureFlags(Set.of(\"cool-new-feature\")));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .connector\n .patch(\n \"connector_id\",\n {\n name: \"sample string\",\n logo: \"sample string\",\n description: \"sample string\",\n kind: ConnectorKind::CUSTOM,\n instructions: \"sample string\",\n allowedEventTypes: [\"user.signup\", \"user.deleted\"],\n transformation: \"sample string\",\n featureFlags: [\"cool-new-feature\"]\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .connector()\n .patch(\n \"connector_id\".to_string(),\n ConnectorPatch {\n name: Some(\"sample string\".to_string()),\n logo: js_option::JsOption::Some(\"sample string\".to_string()),\n description: Some(\"sample string\".to_string()),\n kind: Some(ConnectorKind::Custom),\n instructions: Some(\"sample string\".to_string()),\n allowed_event_types: js_option::JsOption::Some(\n vec![\"user.signup\".to_string(), \"user.deleted\".to_string()],\n ),\n transformation: Some(\"sample string\".to_string()),\n feature_flags: js_option::JsOption::Some(\n vec![\"cool-new-feature\".to_string()],\n ),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Connector.Patch(\n \"connector_id\",\n new ConnectorPatch\n {\n Name = \"sample string\",\n Logo = \"sample string\",\n Description = \"sample string\",\n Kind = ConnectorKind.Custom,\n Instructions = \"sample string\",\n AllowedEventTypes = MaybeUnset<List<string>?>.Set([\"user.signup\", \"user.deleted\"]),\n Transformation = \"sample string\",\n FeatureFlags = MaybeUnset<List<string>?>.Set([\"cool-new-feature\"]),\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->connector->patch(\n \"connector_id\",\n ConnectorPatch::create()\n ->withName(\"sample string\")\n ->withLogo(\"sample string\")\n ->withDescription(\"sample string\")\n ->withKind(ConnectorKind::CUSTOM)\n ->withInstructions(\"sample string\")\n ->withAllowedEventTypes([\"user.signup\",\"user.deleted\"])\n ->withTransformation(\"sample string\")\n ->withFeatureFlags([\"cool-new-feature\"])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix connector patch \"connector_id\" '{\n \"allowedEventTypes\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"description\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"instructions\": \"sample string\",\n \"kind\": \"Custom\",\n \"logo\": \"sample string\",\n \"name\": \"sample string\",\n \"transformation\": \"sample string\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PATCH' \\\n 'https://api.eu.svix.com/api/v1/connector/connector_id' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"allowedEventTypes\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"description\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"instructions\": \"sample string\",\n \"kind\": \"Custom\",\n \"logo\": \"sample string\",\n \"name\": \"sample string\",\n \"transformation\": \"sample string\"\n }'"
}
]
}
},
"/api/v1/environment/export": {
"post": {
"tags": [
"Environment"
],
"summary": "Export Environment Configuration",
"description": "Download a JSON file containing all org-settings and event types.\n\nNote that the schema for [`EnvironmentOut`] is subject to change. The fields\nherein are provided for convenience but should be treated as JSON blobs.",
"operationId": "v1.environment.export",
"parameters": [
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.environment.export();"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.environment.export();"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.environment.export()"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.environment.export()"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Environment.Export(ctx, nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.environment.export()"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEnvironment().export();"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.environment.export"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.environment().export(None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Environment.Export();"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->environment->export();"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix environment export"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/environment/export' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/environment/import": {
"post": {
"tags": [
"Environment"
],
"summary": "Import Environment Configuration",
"description": "Import a configuration into the active organization.\n\nIt doesn't delete anything, only adds / updates what was passed to it.\n\nNote that the schema for [`EnvironmentIn`] is subject to change. The fields\nherein are provided for convenience but should be treated as JSON blobs.",
"operationId": "v1.environment.import",
"parameters": [
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentIn"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.environment.import({\n eventTypes: [],\n settings: {},\n connectors: [],\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.environment.import({\n eventTypes: [],\n settings: {},\n connectors: [],\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.environment.import_(\n EnvironmentIn(\n event_types=[],\n settings={},\n connectors=[],\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.environment.import_(\n EnvironmentIn(\n event_types=[],\n settings={},\n connectors=[],\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Environment.Import(\n\tctx,\n\tEnvironmentIn{EventTypes: []EventTypeIn{}, Settings: nil, Connectors: []ConnectorIn{}},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.environment.import(\n EnvironmentIn(eventTypes = listOf(), settings = mapOf(), connectors = listOf())\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getEnvironment()\n .import_(\n new EnvironmentIn().eventTypes(List.of()).settings(Map.of()).connectors(List.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.environment.import({eventTypes: [], settings: {}, connectors: []})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.environment()\n .import(\n EnvironmentIn {\n event_types: Some(vec![]),\n settings: Some(serde_json::json!({})),\n connectors: Some(vec![]),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Environment.Import(\n new EnvironmentIn\n {\n EventTypes = [],\n Settings = new Dictionary<string, string> { },\n Connectors = [],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->environment->import(\n EnvironmentIn::create()\n ->withEventTypes([])\n ->withConnectors([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix environment import '{\n \"connectors\": [],\n \"eventTypes\": [],\n \"settings\": {}\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/environment/import' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"connectors\": [],\n \"eventTypes\": [],\n \"settings\": {}\n }'"
}
]
}
},
"/api/v1/event-type": {
"get": {
"tags": [
"Event Type"
],
"summary": "List Event Types",
"description": "Return the list of event types.",
"operationId": "v1.event-type.list",
"parameters": [
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"nullable": true,
"example": "user.signup"
},
"style": "form"
},
{
"in": "query",
"name": "order",
"description": "The sorting order of the returned items",
"schema": {
"description": "The sorting order of the returned items",
"$ref": "#/components/schemas/Ordering",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "include_archived",
"description": "When `true` archived (deleted but not expunged) items are included in the response.",
"schema": {
"description": "When `true` archived (deleted but not expunged) items are included in the response.",
"default": false,
"type": "boolean"
},
"style": "form"
},
{
"in": "query",
"name": "with_content",
"description": "When `true` the full item (including the schema) is included in the response.",
"schema": {
"description": "When `true` the full item (including the schema) is included in the response.",
"default": false,
"type": "boolean"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_EventTypeOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.eventType.list();"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.eventType.list();"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.event_type.list()"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.event_type.list()"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.EventType.List(ctx, nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.eventType.list()"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEventType().list();"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.event_type.list"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.event_type().list(None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.EventType.List();"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->eventType->list();"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix event-type list"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/event-type' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"post": {
"tags": [
"Event Type"
],
"summary": "Create Event Type",
"description": "Create new or unarchive existing event type.\n\nUnarchiving an event type will allow endpoints to filter on it and messages to be sent with it.\nEndpoints filtering on the event type before archival will continue to filter on it.\nThis operation does not preserve the description and schemas.",
"operationId": "v1.event-type.create",
"parameters": [
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeIn"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.eventType.create({\n name: \"user.signup\",\n description: \"A user has signed up\",\n archived: true,\n deprecated: true,\n schemas: {\n \"1\": {\n description: \"An invoice was paid by a user\",\n properties: {\n invoiceId: { description: \"The invoice id\", type: \"string\" },\n userId: { description: \"The user id\", type: \"string\" },\n },\n required: [\"invoiceId\", \"userId\"],\n title: \"Invoice Paid Event\",\n type: \"object\",\n },\n },\n groupName: \"user\",\n featureFlags: [\"cool-new-feature\"],\n featureFlag: \"sample string\",\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.eventType.create({\n name: \"user.signup\",\n description: \"A user has signed up\",\n archived: true,\n deprecated: true,\n schemas: {\n \"1\": {\n description: \"An invoice was paid by a user\",\n properties: {\n invoiceId: { description: \"The invoice id\", type: \"string\" },\n userId: { description: \"The user id\", type: \"string\" },\n },\n required: [\"invoiceId\", \"userId\"],\n title: \"Invoice Paid Event\",\n type: \"object\",\n },\n },\n groupName: \"user\",\n featureFlags: [\"cool-new-feature\"],\n featureFlag: \"sample string\",\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.event_type.create(\n EventTypeIn(\n name=\"user.signup\",\n description=\"A user has signed up\",\n archived=True,\n deprecated=True,\n schemas={\n \"1\": {\n \"description\": \"An invoice was paid by a user\",\n \"properties\": {\n \"invoiceId\": {\"description\": \"The invoice id\", \"type\": \"string\"},\n \"userId\": {\"description\": \"The user id\", \"type\": \"string\"},\n },\n \"required\": [\"invoiceId\", \"userId\"],\n \"title\": \"Invoice Paid Event\",\n \"type\": \"object\",\n }\n },\n group_name=\"user\",\n feature_flags=[\n \"cool-new-feature\",\n ],\n feature_flag=\"sample string\",\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.event_type.create(\n EventTypeIn(\n name=\"user.signup\",\n description=\"A user has signed up\",\n archived=True,\n deprecated=True,\n schemas={\n \"1\": {\n \"description\": \"An invoice was paid by a user\",\n \"properties\": {\n \"invoiceId\": {\"description\": \"The invoice id\", \"type\": \"string\"},\n \"userId\": {\"description\": \"The user id\", \"type\": \"string\"},\n },\n \"required\": [\"invoiceId\", \"userId\"],\n \"title\": \"Invoice Paid Event\",\n \"type\": \"object\",\n }\n },\n group_name=\"user\",\n feature_flags=[\n \"cool-new-feature\",\n ],\n feature_flag=\"sample string\",\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.EventType.Create(\n\tctx,\n\tEventTypeIn{\n\t\tName: \"user.signup\",\n\t\tDescription: \"A user has signed up\",\n\t\tArchived: ptr(true),\n\t\tDeprecated: ptr(true),\n\t\tSchemas: nil,\n\t\tGroupName: ptr(\"user\"),\n\t\tFeatureFlags: []string{\"cool-new-feature\"},\n\t\tFeatureFlag: ptr(\"sample string\"),\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.eventType.create(\n EventTypeIn(\n name = \"user.signup\",\n description = \"A user has signed up\",\n archived = true,\n deprecated = true,\n schemas = mapOf(),\n groupName = \"user\",\n featureFlags = setOf(\"cool-new-feature\"),\n featureFlag = \"sample string\",\n )\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEventType()\n .create(new EventTypeIn()\n .name(\"user.signup\")\n .description(\"A user has signed up\")\n .archived(true)\n .deprecated(true)\n .schemas(Map.of())\n .groupName(\"user\")\n .featureFlags(Set.of(\"cool-new-feature\"))\n .featureFlag(\"sample string\"));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .event_type\n .create(\n {\n name: \"user.signup\",\n description: \"A user has signed up\",\n archived: true,\n deprecated: true,\n schemas: {},\n groupName: \"user\",\n featureFlags: [\"cool-new-feature\"],\n featureFlag: \"sample string\"\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .event_type()\n .create(\n EventTypeIn {\n name: \"user.signup\".to_string(),\n description: \"A user has signed up\".to_string(),\n archived: Some(true),\n deprecated: Some(true),\n schemas: Some(\n serde_json::json!(\n { \"1\" : { \"description\" : \"An invoice was paid by a user\",\n \"properties\" : { \"invoiceId\" : { \"description\" :\n \"The invoice id\", \"type\" : \"string\" }, \"userId\" : { \"description\"\n : \"The user id\", \"type\" : \"string\" } }, \"required\" :\n [\"invoiceId\", \"userId\"], \"title\" : \"Invoice Paid Event\", \"type\" :\n \"object\" } }\n ),\n ),\n group_name: Some(\"user\".to_string()),\n feature_flags: Some(vec![\"cool-new-feature\".to_string()]),\n feature_flag: Some(\"sample string\".to_string()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.EventType.Create(\n new EventTypeIn\n {\n Name = \"user.signup\",\n Description = \"A user has signed up\",\n Archived = true,\n Deprecated = true,\n Schemas = new Dictionary<string, string> { },\n GroupName = \"user\",\n FeatureFlags = [\"cool-new-feature\"],\n FeatureFlag = \"sample string\",\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->eventType->create(\n EventTypeIn::create(\n name: \"user.signup\",\n description: \"A user has signed up\"\n )\n ->withArchived(true)\n ->withDeprecated(true)\n ->withGroupName(\"user\")\n ->withFeatureFlags([\"cool-new-feature\"])\n ->withFeatureFlag(\"sample string\")\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix event-type create '{\n \"archived\": true,\n \"deprecated\": true,\n \"description\": \"A user has signed up\",\n \"featureFlag\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"groupName\": \"user\",\n \"name\": \"user.signup\",\n \"schemas\": {\n \"1\": {\n \"description\": \"An invoice was paid by a user\",\n \"properties\": {\n \"invoiceId\": {\n \"description\": \"The invoice id\",\n \"type\": \"string\"\n },\n \"userId\": {\n \"description\": \"The user id\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"invoiceId\",\n \"userId\"\n ],\n \"title\": \"Invoice Paid Event\",\n \"type\": \"object\"\n }\n }\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/event-type' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"archived\": true,\n \"deprecated\": true,\n \"description\": \"A user has signed up\",\n \"featureFlag\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"groupName\": \"user\",\n \"name\": \"user.signup\",\n \"schemas\": {\n \"1\": {\n \"description\": \"An invoice was paid by a user\",\n \"properties\": {\n \"invoiceId\": {\n \"description\": \"The invoice id\",\n \"type\": \"string\"\n },\n \"userId\": {\n \"description\": \"The user id\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"invoiceId\",\n \"userId\"\n ],\n \"title\": \"Invoice Paid Event\",\n \"type\": \"object\"\n }\n }\n }'"
}
]
}
},
"/api/v1/event-type/import/openapi": {
"post": {
"tags": [
"Event Type"
],
"summary": "Event Type Import From Openapi",
"description": "Given an OpenAPI spec, create new or update existing event types.\n\nIf an existing `archived` event type is updated, it will be unarchived.\nThe importer will convert all webhooks found in the either the `webhooks` or `x-webhooks`\ntop-level.",
"operationId": "v1.event-type.import-openapi",
"parameters": [
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"description": "Import a list of event types from webhooks defined in an OpenAPI spec.\n\nThe OpenAPI spec can be specified as either `spec` given the spec as a JSON object, or as `specRaw` (a `string`) which will be parsed as YAML or JSON by the server. Sending neither or both is invalid, resulting in a `400` **Bad Request**.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeImportOpenApiIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeImportOpenApiOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.eventType.importOpenapi({\n dryRun: true,\n replaceAll: true,\n spec: {\n info: { title: \"Webhook Example\", version: \"1.0.0\" },\n openapi: \"3.1.0\",\n webhooks: {\n \"pet.new\": {\n post: {\n requestBody: {\n content: {\n \"application/json\": {\n schema: {\n properties: {\n id: { format: \"int64\", type: \"integer\" },\n name: { type: \"string\" },\n tag: { type: \"string\" },\n },\n required: [\"id\", \"name\"],\n },\n },\n },\n description: \"Information about a new pet in the system\",\n },\n responses: {\n \"200\": {\n description:\n \"Return a 200 status to indicate that the data was received successfully\",\n },\n },\n },\n },\n },\n },\n specRaw: \"sample string\",\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.eventType.importOpenapi({\n dryRun: true,\n replaceAll: true,\n spec: {\n info: { title: \"Webhook Example\", version: \"1.0.0\" },\n openapi: \"3.1.0\",\n webhooks: {\n \"pet.new\": {\n post: {\n requestBody: {\n content: {\n \"application/json\": {\n schema: {\n properties: {\n id: { format: \"int64\", type: \"integer\" },\n name: { type: \"string\" },\n tag: { type: \"string\" },\n },\n required: [\"id\", \"name\"],\n },\n },\n },\n description: \"Information about a new pet in the system\",\n },\n responses: {\n \"200\": {\n description:\n \"Return a 200 status to indicate that the data was received successfully\",\n },\n },\n },\n },\n },\n },\n specRaw: \"sample string\",\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.event_type.import_openapi(\n EventTypeImportOpenApiIn(\n dry_run=True,\n replace_all=True,\n spec={\n \"info\": {\"title\": \"Webhook Example\", \"version\": \"1.0.0\"},\n \"openapi\": \"3.1.0\",\n \"webhooks\": {\n \"pet.new\": {\n \"post\": {\n \"requestBody\": {\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"properties\": {\n \"id\": {\n \"format\": \"int64\",\n \"type\": \"integer\",\n },\n \"name\": {\"type\": \"string\"},\n \"tag\": {\"type\": \"string\"},\n },\n \"required\": [\"id\", \"name\"],\n }\n }\n },\n \"description\": \"Information about a new pet in the system\",\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Return a 200 status to indicate that the data was received successfully\"\n }\n },\n }\n }\n },\n },\n spec_raw=\"sample string\",\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.event_type.import_openapi(\n EventTypeImportOpenApiIn(\n dry_run=True,\n replace_all=True,\n spec={\n \"info\": {\"title\": \"Webhook Example\", \"version\": \"1.0.0\"},\n \"openapi\": \"3.1.0\",\n \"webhooks\": {\n \"pet.new\": {\n \"post\": {\n \"requestBody\": {\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"properties\": {\n \"id\": {\n \"format\": \"int64\",\n \"type\": \"integer\",\n },\n \"name\": {\"type\": \"string\"},\n \"tag\": {\"type\": \"string\"},\n },\n \"required\": [\"id\", \"name\"],\n }\n }\n },\n \"description\": \"Information about a new pet in the system\",\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Return a 200 status to indicate that the data was received successfully\"\n }\n },\n }\n }\n },\n },\n spec_raw=\"sample string\",\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.EventType.ImportOpenapi(\n\tctx,\n\tEventTypeImportOpenApiIn{\n\t\tDryRun: ptr(true),\n\t\tReplaceAll: ptr(true),\n\t\tSpec: nil,\n\t\tSpecRaw: ptr(\"sample string\"),\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.eventType.importOpenapi(\n EventTypeImportOpenApiIn(\n dryRun = true,\n replaceAll = true,\n spec = mapOf(),\n specRaw = \"sample string\",\n )\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEventType()\n .importOpenapi(new EventTypeImportOpenApiIn()\n .dryRun(true)\n .replaceAll(true)\n .spec(Map.of())\n .specRaw(\"sample string\"));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.event_type.import_openapi({dryRun: true, replaceAll: true, spec: {}, specRaw: \"sample string\"})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .event_type()\n .import_openapi(\n EventTypeImportOpenApiIn {\n dry_run: Some(true),\n replace_all: Some(true),\n spec: Some(\n serde_json::json!(\n { \"info\" : { \"title\" : \"Webhook Example\", \"version\" : \"1.0.0\" },\n \"openapi\" : \"3.1.0\", \"webhooks\" : { \"pet.new\" : { \"post\" : {\n \"requestBody\" : { \"content\" : { \"application/json\" : { \"schema\" :\n { \"properties\" : { \"id\" : { \"format\" : \"int64\", \"type\" :\n \"integer\" }, \"name\" : { \"type\" : \"string\" }, \"tag\" : { \"type\" :\n \"string\" } }, \"required\" : [\"id\", \"name\"] } } }, \"description\" :\n \"Information about a new pet in the system\" }, \"responses\" : {\n \"200\" : { \"description\" :\n \"Return a 200 status to indicate that the data was received successfully\"\n } } } } } }\n ),\n ),\n spec_raw: Some(\"sample string\".to_string()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.EventType.ImportOpenapi(\n new EventTypeImportOpenApiIn\n {\n DryRun = true,\n ReplaceAll = true,\n Spec = new Dictionary<string, string> { },\n SpecRaw = \"sample string\",\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->eventType->importOpenapi(\n EventTypeImportOpenApiIn::create()\n ->withDryRun(true)\n ->withReplaceAll(true)\n ->withSpecRaw(\"sample string\")\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix event-type import-openapi '{\n \"dryRun\": true,\n \"replaceAll\": true,\n \"spec\": {\n \"info\": {\n \"title\": \"Webhook Example\",\n \"version\": \"1.0.0\"\n },\n \"openapi\": \"3.1.0\",\n \"webhooks\": {\n \"pet.new\": {\n \"post\": {\n \"requestBody\": {\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"properties\": {\n \"id\": {\n \"format\": \"int64\",\n \"type\": \"integer\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"tag\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"id\",\n \"name\"\n ]\n }\n }\n },\n \"description\": \"Information about a new pet in the system\"\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Return a 200 status to indicate that the data was received successfully\"\n }\n }\n }\n }\n }\n },\n \"specRaw\": \"sample string\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/event-type/import/openapi' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"dryRun\": true,\n \"replaceAll\": true,\n \"spec\": {\n \"info\": {\n \"title\": \"Webhook Example\",\n \"version\": \"1.0.0\"\n },\n \"openapi\": \"3.1.0\",\n \"webhooks\": {\n \"pet.new\": {\n \"post\": {\n \"requestBody\": {\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"properties\": {\n \"id\": {\n \"format\": \"int64\",\n \"type\": \"integer\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"tag\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"id\",\n \"name\"\n ]\n }\n }\n },\n \"description\": \"Information about a new pet in the system\"\n },\n \"responses\": {\n \"200\": {\n \"description\": \"Return a 200 status to indicate that the data was received successfully\"\n }\n }\n }\n }\n }\n },\n \"specRaw\": \"sample string\"\n }'"
}
]
}
},
"/api/v1/event-type/{event_type_name}": {
"get": {
"tags": [
"Event Type"
],
"summary": "Get Event Type",
"description": "Get an event type.",
"operationId": "v1.event-type.get",
"parameters": [
{
"in": "path",
"name": "event_type_name",
"description": "The event type's name",
"required": true,
"schema": {
"description": "The event type's name",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "user.signup"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.eventType.get(\"user.signup\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.eventType.get(\"user.signup\");"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.event_type.get(\n \"user.signup\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.event_type.get(\n \"user.signup\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.EventType.Get(ctx, \"user.signup\")"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.eventType.get(\"user.signup\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEventType().get(\"user.signup\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.event_type.get(\"user.signup\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.event_type().get(\"user.signup\".to_string()).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.EventType.Get(\"user.signup\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->eventType->get(\n \"user.signup\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix event-type get \"user.signup\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/event-type/user.signup' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"put": {
"tags": [
"Event Type"
],
"summary": "Update Event Type",
"description": "Update an event type.",
"operationId": "v1.event-type.update",
"parameters": [
{
"in": "path",
"name": "event_type_name",
"description": "The event type's name",
"required": true,
"schema": {
"description": "The event type's name",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "user.signup"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeOut"
}
}
}
},
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.eventType.update(\"user.signup\", {\n description: \"A user has signed up\",\n archived: true,\n deprecated: true,\n schemas: {\n \"1\": {\n description: \"An invoice was paid by a user\",\n properties: {\n invoiceId: { description: \"The invoice id\", type: \"string\" },\n userId: { description: \"The user id\", type: \"string\" },\n },\n required: [\"invoiceId\", \"userId\"],\n title: \"Invoice Paid Event\",\n type: \"object\",\n },\n },\n featureFlags: [\"cool-new-feature\"],\n featureFlag: \"sample string\",\n groupName: \"user\",\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.eventType.update(\"user.signup\", {\n description: \"A user has signed up\",\n archived: true,\n deprecated: true,\n schemas: {\n \"1\": {\n description: \"An invoice was paid by a user\",\n properties: {\n invoiceId: { description: \"The invoice id\", type: \"string\" },\n userId: { description: \"The user id\", type: \"string\" },\n },\n required: [\"invoiceId\", \"userId\"],\n title: \"Invoice Paid Event\",\n type: \"object\",\n },\n },\n featureFlags: [\"cool-new-feature\"],\n featureFlag: \"sample string\",\n groupName: \"user\",\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.event_type.update(\n \"user.signup\",\n EventTypeUpdate(\n description=\"A user has signed up\",\n archived=True,\n deprecated=True,\n schemas={\n \"1\": {\n \"description\": \"An invoice was paid by a user\",\n \"properties\": {\n \"invoiceId\": {\"description\": \"The invoice id\", \"type\": \"string\"},\n \"userId\": {\"description\": \"The user id\", \"type\": \"string\"},\n },\n \"required\": [\"invoiceId\", \"userId\"],\n \"title\": \"Invoice Paid Event\",\n \"type\": \"object\",\n }\n },\n feature_flags=[\n \"cool-new-feature\",\n ],\n feature_flag=\"sample string\",\n group_name=\"user\",\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.event_type.update(\n \"user.signup\",\n EventTypeUpdate(\n description=\"A user has signed up\",\n archived=True,\n deprecated=True,\n schemas={\n \"1\": {\n \"description\": \"An invoice was paid by a user\",\n \"properties\": {\n \"invoiceId\": {\"description\": \"The invoice id\", \"type\": \"string\"},\n \"userId\": {\"description\": \"The user id\", \"type\": \"string\"},\n },\n \"required\": [\"invoiceId\", \"userId\"],\n \"title\": \"Invoice Paid Event\",\n \"type\": \"object\",\n }\n },\n feature_flags=[\n \"cool-new-feature\",\n ],\n feature_flag=\"sample string\",\n group_name=\"user\",\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.EventType.Update(\n\tctx,\n\t\"user.signup\",\n\tEventTypeUpdate{\n\t\tDescription: \"A user has signed up\",\n\t\tArchived: ptr(true),\n\t\tDeprecated: ptr(true),\n\t\tSchemas: nil,\n\t\tFeatureFlags: []string{\"cool-new-feature\"},\n\t\tFeatureFlag: ptr(\"sample string\"),\n\t\tGroupName: ptr(\"user\"),\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.eventType.update(\n \"user.signup\",\n EventTypeUpdate(\n description = \"A user has signed up\",\n archived = true,\n deprecated = true,\n schemas = mapOf(),\n featureFlags = setOf(\"cool-new-feature\"),\n featureFlag = \"sample string\",\n groupName = \"user\",\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEventType()\n .update(\n \"user.signup\",\n new EventTypeUpdate()\n .description(\"A user has signed up\")\n .archived(true)\n .deprecated(true)\n .schemas(Map.of())\n .featureFlags(Set.of(\"cool-new-feature\"))\n .featureFlag(\"sample string\")\n .groupName(\"user\"));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .event_type\n .update(\n \"user.signup\",\n {\n description: \"A user has signed up\",\n archived: true,\n deprecated: true,\n schemas: {},\n featureFlags: [\"cool-new-feature\"],\n featureFlag: \"sample string\",\n groupName: \"user\"\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .event_type()\n .update(\n \"user.signup\".to_string(),\n EventTypeUpdate {\n description: \"A user has signed up\".to_string(),\n archived: Some(true),\n deprecated: Some(true),\n schemas: Some(\n serde_json::json!(\n { \"1\" : { \"description\" : \"An invoice was paid by a user\",\n \"properties\" : { \"invoiceId\" : { \"description\" :\n \"The invoice id\", \"type\" : \"string\" }, \"userId\" : { \"description\"\n : \"The user id\", \"type\" : \"string\" } }, \"required\" :\n [\"invoiceId\", \"userId\"], \"title\" : \"Invoice Paid Event\", \"type\" :\n \"object\" } }\n ),\n ),\n feature_flags: Some(vec![\"cool-new-feature\".to_string()]),\n feature_flag: Some(\"sample string\".to_string()),\n group_name: Some(\"user\".to_string()),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.EventType.Update(\n \"user.signup\",\n new EventTypeUpdate\n {\n Description = \"A user has signed up\",\n Archived = true,\n Deprecated = true,\n Schemas = new Dictionary<string, string> { },\n FeatureFlags = [\"cool-new-feature\"],\n FeatureFlag = \"sample string\",\n GroupName = \"user\",\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->eventType->update(\n \"user.signup\",\n EventTypeUpdate::create(\n description: \"A user has signed up\"\n )\n ->withArchived(true)\n ->withDeprecated(true)\n ->withFeatureFlags([\"cool-new-feature\"])\n ->withFeatureFlag(\"sample string\")\n ->withGroupName(\"user\")\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix event-type update \"user.signup\" '{\n \"archived\": true,\n \"deprecated\": true,\n \"description\": \"A user has signed up\",\n \"featureFlag\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"groupName\": \"user\",\n \"schemas\": {\n \"1\": {\n \"description\": \"An invoice was paid by a user\",\n \"properties\": {\n \"invoiceId\": {\n \"description\": \"The invoice id\",\n \"type\": \"string\"\n },\n \"userId\": {\n \"description\": \"The user id\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"invoiceId\",\n \"userId\"\n ],\n \"title\": \"Invoice Paid Event\",\n \"type\": \"object\"\n }\n }\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PUT' \\\n 'https://api.eu.svix.com/api/v1/event-type/user.signup' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"archived\": true,\n \"deprecated\": true,\n \"description\": \"A user has signed up\",\n \"featureFlag\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"groupName\": \"user\",\n \"schemas\": {\n \"1\": {\n \"description\": \"An invoice was paid by a user\",\n \"properties\": {\n \"invoiceId\": {\n \"description\": \"The invoice id\",\n \"type\": \"string\"\n },\n \"userId\": {\n \"description\": \"The user id\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"invoiceId\",\n \"userId\"\n ],\n \"title\": \"Invoice Paid Event\",\n \"type\": \"object\"\n }\n }\n }'"
}
]
},
"delete": {
"tags": [
"Event Type"
],
"summary": "Delete Event Type",
"description": "Archive an event type.\n\nEndpoints already configured to filter on an event type will continue to do so after archival.\nHowever, new messages can not be sent with it and endpoints can not filter on it.\nAn event type can be unarchived with the\n[create operation](#operation/create_event_type_api_v1_event_type__post).",
"operationId": "v1.event-type.delete",
"parameters": [
{
"in": "path",
"name": "event_type_name",
"description": "The event type's name",
"required": true,
"schema": {
"description": "The event type's name",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "user.signup"
},
"style": "simple"
},
{
"in": "query",
"name": "expunge",
"description": "By default event types are archived when \"deleted\". Passing this to `true` deletes them entirely.",
"schema": {
"description": "By default event types are archived when \"deleted\". Passing this to `true` deletes them entirely.",
"default": false,
"type": "boolean"
},
"style": "form"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.eventType.delete(\"user.signup\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.eventType.delete(\"user.signup\");"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.event_type.delete(\n \"user.signup\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.event_type.delete(\n \"user.signup\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.EventType.Delete(ctx, \"user.signup\", nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.eventType.delete(\n \"user.signup\"\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getEventType().delete(\"user.signup\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.event_type.delete(\"user.signup\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.event_type().delete(\"user.signup\".to_string(), None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.EventType.Delete(\"user.signup\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->eventType->delete(\n \"user.signup\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix event-type delete \"user.signup\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'DELETE' \\\n 'https://api.eu.svix.com/api/v1/event-type/user.signup' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
},
"patch": {
"tags": [
"Event Type"
],
"summary": "Patch Event Type",
"description": "Partially update an event type.",
"operationId": "v1.event-type.patch",
"parameters": [
{
"in": "path",
"name": "event_type_name",
"description": "The event type's name",
"required": true,
"schema": {
"description": "The event type's name",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "user.signup"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypePatch"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.eventType.patch(\"user.signup\", {\n description: \"sample string\",\n archived: true,\n deprecated: true,\n schemas: {\n description: \"An invoice was paid by a user\",\n properties: {\n invoiceId: { description: \"The invoice id\", type: \"string\" },\n userId: { description: \"The user id\", type: \"string\" },\n },\n required: [\"invoiceId\", \"userId\"],\n title: \"Invoice Paid Event\",\n type: \"object\",\n },\n featureFlags: [\"cool-new-feature\"],\n featureFlag: \"sample string\",\n groupName: \"user\",\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.eventType.patch(\"user.signup\", {\n description: \"sample string\",\n archived: true,\n deprecated: true,\n schemas: {\n description: \"An invoice was paid by a user\",\n properties: {\n invoiceId: { description: \"The invoice id\", type: \"string\" },\n userId: { description: \"The user id\", type: \"string\" },\n },\n required: [\"invoiceId\", \"userId\"],\n title: \"Invoice Paid Event\",\n type: \"object\",\n },\n featureFlags: [\"cool-new-feature\"],\n featureFlag: \"sample string\",\n groupName: \"user\",\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.event_type.patch(\n \"user.signup\",\n EventTypePatch(\n description=\"sample string\",\n archived=True,\n deprecated=True,\n schemas={\n \"description\": \"An invoice was paid by a user\",\n \"properties\": {\n \"invoiceId\": {\"description\": \"The invoice id\", \"type\": \"string\"},\n \"userId\": {\"description\": \"The user id\", \"type\": \"string\"},\n },\n \"required\": [\"invoiceId\", \"userId\"],\n \"title\": \"Invoice Paid Event\",\n \"type\": \"object\",\n },\n feature_flags=[\n \"cool-new-feature\",\n ],\n feature_flag=\"sample string\",\n group_name=\"user\",\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.event_type.patch(\n \"user.signup\",\n EventTypePatch(\n description=\"sample string\",\n archived=True,\n deprecated=True,\n schemas={\n \"description\": \"An invoice was paid by a user\",\n \"properties\": {\n \"invoiceId\": {\"description\": \"The invoice id\", \"type\": \"string\"},\n \"userId\": {\"description\": \"The user id\", \"type\": \"string\"},\n },\n \"required\": [\"invoiceId\", \"userId\"],\n \"title\": \"Invoice Paid Event\",\n \"type\": \"object\",\n },\n feature_flags=[\n \"cool-new-feature\",\n ],\n feature_flag=\"sample string\",\n group_name=\"user\",\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.EventType.Patch(\n\tctx,\n\t\"user.signup\",\n\tEventTypePatch{\n\t\tDescription: ptr(\"sample string\"),\n\t\tArchived: ptr(true),\n\t\tDeprecated: ptr(true),\n\t\tSchemas: NewUnsetNullable[map[string]any](),\n\t\tFeatureFlags: NewNullable([]string{\"cool-new-feature\"}),\n\t\tFeatureFlag: NewNullable(\"sample string\"),\n\t\tGroupName: NewNullable(\"user\"),\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.eventType.patch(\n \"user.signup\",\n EventTypePatch(\n description = \"sample string\",\n archived = true,\n deprecated = true,\n schemas = MaybeUnset.Present(mapOf()),\n featureFlags = MaybeUnset.Present(setOf(\"cool-new-feature\")),\n featureFlag = MaybeUnset.Present(\"sample string\"),\n groupName = MaybeUnset.Present(\"user\"),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getEventType()\n .patch(\n \"user.signup\",\n new EventTypePatch()\n .description(\"sample string\")\n .archived(true)\n .deprecated(true)\n .schemas(Map.of())\n .featureFlags(Set.of(\"cool-new-feature\"))\n .featureFlag(\"sample string\")\n .groupName(\"user\"));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .event_type\n .patch(\n \"user.signup\",\n {\n description: \"sample string\",\n archived: true,\n deprecated: true,\n schemas: {},\n featureFlags: [\"cool-new-feature\"],\n featureFlag: \"sample string\",\n groupName: \"user\"\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .event_type()\n .patch(\n \"user.signup\".to_string(),\n EventTypePatch {\n description: Some(\"sample string\".to_string()),\n archived: Some(true),\n deprecated: Some(true),\n schemas: js_option::JsOption::Some(\n serde_json::json!(\n { \"description\" : \"An invoice was paid by a user\", \"properties\" :\n { \"invoiceId\" : { \"description\" : \"The invoice id\", \"type\" :\n \"string\" }, \"userId\" : { \"description\" : \"The user id\", \"type\" :\n \"string\" } }, \"required\" : [\"invoiceId\", \"userId\"], \"title\" :\n \"Invoice Paid Event\", \"type\" : \"object\" }\n ),\n ),\n feature_flags: js_option::JsOption::Some(\n vec![\"cool-new-feature\".to_string()],\n ),\n feature_flag: js_option::JsOption::Some(\"sample string\".to_string()),\n group_name: js_option::JsOption::Some(\"user\".to_string()),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.EventType.Patch(\n \"user.signup\",\n new EventTypePatch\n {\n Description = \"sample string\",\n Archived = true,\n Deprecated = true,\n Schemas = new Dictionary<string, string> { },\n FeatureFlags = MaybeUnset<List<string>?>.Set([\"cool-new-feature\"]),\n FeatureFlag = \"sample string\",\n GroupName = \"user\",\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->eventType->patch(\n \"user.signup\",\n EventTypePatch::create()\n ->withDescription(\"sample string\")\n ->withArchived(true)\n ->withDeprecated(true)\n ->withFeatureFlags([\"cool-new-feature\"])\n ->withFeatureFlag(\"sample string\")\n ->withGroupName(\"user\")\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix event-type patch \"user.signup\" '{\n \"archived\": true,\n \"deprecated\": true,\n \"description\": \"sample string\",\n \"featureFlag\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"groupName\": \"user\",\n \"schemas\": {\n \"description\": \"An invoice was paid by a user\",\n \"properties\": {\n \"invoiceId\": {\n \"description\": \"The invoice id\",\n \"type\": \"string\"\n },\n \"userId\": {\n \"description\": \"The user id\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"invoiceId\",\n \"userId\"\n ],\n \"title\": \"Invoice Paid Event\",\n \"type\": \"object\"\n }\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PATCH' \\\n 'https://api.eu.svix.com/api/v1/event-type/user.signup' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"archived\": true,\n \"deprecated\": true,\n \"description\": \"sample string\",\n \"featureFlag\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"groupName\": \"user\",\n \"schemas\": {\n \"description\": \"An invoice was paid by a user\",\n \"properties\": {\n \"invoiceId\": {\n \"description\": \"The invoice id\",\n \"type\": \"string\"\n },\n \"userId\": {\n \"description\": \"The user id\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"invoiceId\",\n \"userId\"\n ],\n \"title\": \"Invoice Paid Event\",\n \"type\": \"object\"\n }\n }'"
}
]
}
},
"/api/v1/health": {
"get": {
"tags": [
"Health"
],
"summary": "Health",
"description": "Verify the API server is up and running.",
"operationId": "v1.health.get",
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
}
}
},
"/api/v1/operational-webhook/endpoint": {
"get": {
"tags": [
"Webhook Endpoint"
],
"summary": "List Operational Webhook Endpoints",
"description": "List operational webhook endpoints.",
"operationId": "v1.operational-webhook.endpoint.list",
"parameters": [
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 30,
"minLength": 30,
"pattern": "^ep_[A-Za-z0-9]{27}$",
"nullable": true,
"example": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2"
},
"style": "form"
},
{
"in": "query",
"name": "order",
"description": "The sorting order of the returned items",
"schema": {
"description": "The sorting order of the returned items",
"$ref": "#/components/schemas/Ordering",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_OperationalWebhookEndpointOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.operationalWebhook.endpoint.list();"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.operationalWebhook.endpoint.list();"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.operational_webhook.endpoint.list()"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.operational_webhook.endpoint.list()"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.OperationalWebhook.Endpoint.List(ctx, nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.operationalWebhook.endpoint.list()"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getOperationalWebhook().getEndpoint().list();"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.operational_webhook.endpoint.list"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.operational_webhook().endpoint().list(None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.OperationalWebhook.Endpoint.List();"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->operationalWebhook->endpoint->list();"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix operational-webhook endpoint list"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/operational-webhook/endpoint' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"post": {
"tags": [
"Webhook Endpoint"
],
"summary": "Create Operational Webhook Endpoint",
"description": "Create an operational webhook endpoint.",
"operationId": "v1.operational-webhook.endpoint.create",
"parameters": [
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationalWebhookEndpointIn"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationalWebhookEndpointOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.operationalWebhook.endpoint.create({\n description: \"An example endpoint name\",\n rateLimit: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n disabled: true,\n filterTypes: [\"message.attempt.failing\"],\n secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n metadata: {},\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.operationalWebhook.endpoint.create({\n description: \"An example endpoint name\",\n rateLimit: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n disabled: true,\n filterTypes: [\"message.attempt.failing\"],\n secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n metadata: {},\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.operational_webhook.endpoint.create(\n OperationalWebhookEndpointIn(\n description=\"An example endpoint name\",\n rate_limit=1,\n uid=\"unique-identifier\",\n url=\"https://example.com/webhook/\",\n disabled=True,\n filter_types=[\n \"message.attempt.failing\",\n ],\n secret=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n metadata={},\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.operational_webhook.endpoint.create(\n OperationalWebhookEndpointIn(\n description=\"An example endpoint name\",\n rate_limit=1,\n uid=\"unique-identifier\",\n url=\"https://example.com/webhook/\",\n disabled=True,\n filter_types=[\n \"message.attempt.failing\",\n ],\n secret=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n metadata={},\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.OperationalWebhook.Endpoint.Create(\n\tctx,\n\tOperationalWebhookEndpointIn{\n\t\tDescription: ptr(\"An example endpoint name\"),\n\t\tRateLimit: ptr(uint16(1)),\n\t\tUid: ptr(\"unique-identifier\"),\n\t\tUrl: \"https://example.com/webhook/\",\n\t\tDisabled: ptr(true),\n\t\tFilterTypes: []string{\"message.attempt.failing\"},\n\t\tSecret: ptr(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"),\n\t\tMetadata: nil,\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.operationalWebhook.endpoint.create(\n OperationalWebhookEndpointIn(\n description = \"An example endpoint name\",\n rateLimit = 1u,\n uid = \"unique-identifier\",\n url = \"https://example.com/webhook/\",\n disabled = true,\n filterTypes = setOf(\"message.attempt.failing\"),\n secret = \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n metadata = mapOf(),\n )\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getOperationalWebhook()\n .getEndpoint()\n .create(new OperationalWebhookEndpointIn()\n .description(\"An example endpoint name\")\n .rateLimit(1L)\n .uid(\"unique-identifier\")\n .url(URI.create(\"https://example.com/webhook/\"))\n .disabled(true)\n .filterTypes(Set.of(\"message.attempt.failing\"))\n .secret(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")\n .metadata(Map.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .operational_webhook\n .endpoint\n .create(\n {\n description: \"An example endpoint name\",\n rateLimit: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n disabled: true,\n filterTypes: [\"message.attempt.failing\"],\n secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n metadata: {}\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .operational_webhook()\n .endpoint()\n .create(\n OperationalWebhookEndpointIn {\n description: Some(\"An example endpoint name\".to_string()),\n rate_limit: Some(1),\n uid: Some(\"unique-identifier\".to_string()),\n url: \"https://example.com/webhook/\".to_string(),\n disabled: Some(true),\n filter_types: Some(vec![\"message.attempt.failing\".to_string()]),\n secret: Some(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\".to_string()),\n metadata: Some(HashMap::new()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.OperationalWebhook.Endpoint.Create(\n new OperationalWebhookEndpointIn\n {\n Description = \"An example endpoint name\",\n RateLimit = 1,\n Uid = \"unique-identifier\",\n Url = \"https://example.com/webhook/\",\n Disabled = true,\n FilterTypes = [\"message.attempt.failing\"],\n Secret = \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n Metadata = [],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->operationalWebhook->endpoint->create(\n OperationalWebhookEndpointIn::create(\n url: \"https://example.com/webhook/\"\n )\n ->withDescription(\"An example endpoint name\")\n ->withRateLimit(1)\n ->withUid(\"unique-identifier\")\n ->withDisabled(true)\n ->withFilterTypes([\"message.attempt.failing\"])\n ->withSecret(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")\n ->withMetadata([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix operational-webhook endpoint create '{\n \"description\": \"An example endpoint name\",\n \"disabled\": true,\n \"filterTypes\": [\n \"message.attempt.failing\"\n ],\n \"metadata\": {},\n \"rateLimit\": 1,\n \"secret\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n \"uid\": \"unique-identifier\",\n \"url\": \"https://example.com/webhook/\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/operational-webhook/endpoint' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"description\": \"An example endpoint name\",\n \"disabled\": true,\n \"filterTypes\": [\n \"message.attempt.failing\"\n ],\n \"metadata\": {},\n \"rateLimit\": 1,\n \"secret\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n \"uid\": \"unique-identifier\",\n \"url\": \"https://example.com/webhook/\"\n }'"
}
]
}
},
"/api/v1/operational-webhook/endpoint/{endpoint_id}": {
"get": {
"tags": [
"Webhook Endpoint"
],
"summary": "Get Operational Webhook Endpoint",
"description": "Get an operational webhook endpoint.",
"operationId": "v1.operational-webhook.endpoint.get",
"parameters": [
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationalWebhookEndpointOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.operationalWebhook.endpoint.get(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.operationalWebhook.endpoint.get(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.operational_webhook.endpoint.get(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.operational_webhook.endpoint.get(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.OperationalWebhook.Endpoint.Get(ctx, \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.operationalWebhook.endpoint.get(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getOperationalWebhook().getEndpoint().get(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.operational_webhook.endpoint.get(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .operational_webhook()\n .endpoint()\n .get(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string())\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.OperationalWebhook.Endpoint.Get(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->operationalWebhook->endpoint->get(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix operational-webhook endpoint get \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/operational-webhook/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"put": {
"tags": [
"Webhook Endpoint"
],
"summary": "Update Operational Webhook Endpoint",
"description": "Update an operational webhook endpoint.",
"operationId": "v1.operational-webhook.endpoint.update",
"parameters": [
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationalWebhookEndpointUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationalWebhookEndpointOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.operationalWebhook.endpoint.update(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n description: \"An example endpoint name\",\n rateLimit: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n disabled: true,\n filterTypes: [\"message.attempt.failing\"],\n metadata: {},\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.operationalWebhook.endpoint.update(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n description: \"An example endpoint name\",\n rateLimit: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n disabled: true,\n filterTypes: [\"message.attempt.failing\"],\n metadata: {},\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.operational_webhook.endpoint.update(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n OperationalWebhookEndpointUpdate(\n description=\"An example endpoint name\",\n rate_limit=1,\n uid=\"unique-identifier\",\n url=\"https://example.com/webhook/\",\n disabled=True,\n filter_types=[\n \"message.attempt.failing\",\n ],\n metadata={},\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.operational_webhook.endpoint.update(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n OperationalWebhookEndpointUpdate(\n description=\"An example endpoint name\",\n rate_limit=1,\n uid=\"unique-identifier\",\n url=\"https://example.com/webhook/\",\n disabled=True,\n filter_types=[\n \"message.attempt.failing\",\n ],\n metadata={},\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.OperationalWebhook.Endpoint.Update(\n\tctx,\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tOperationalWebhookEndpointUpdate{\n\t\tDescription: ptr(\"An example endpoint name\"),\n\t\tRateLimit: ptr(uint16(1)),\n\t\tUid: ptr(\"unique-identifier\"),\n\t\tUrl: \"https://example.com/webhook/\",\n\t\tDisabled: ptr(true),\n\t\tFilterTypes: []string{\"message.attempt.failing\"},\n\t\tMetadata: nil,\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.operationalWebhook.endpoint.update(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n OperationalWebhookEndpointUpdate(\n description = \"An example endpoint name\",\n rateLimit = 1u,\n uid = \"unique-identifier\",\n url = \"https://example.com/webhook/\",\n disabled = true,\n filterTypes = setOf(\"message.attempt.failing\"),\n metadata = mapOf(),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getOperationalWebhook()\n .getEndpoint()\n .update(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new OperationalWebhookEndpointUpdate()\n .description(\"An example endpoint name\")\n .rateLimit(1L)\n .uid(\"unique-identifier\")\n .url(URI.create(\"https://example.com/webhook/\"))\n .disabled(true)\n .filterTypes(Set.of(\"message.attempt.failing\"))\n .metadata(Map.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .operational_webhook\n .endpoint\n .update(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n description: \"An example endpoint name\",\n rateLimit: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n disabled: true,\n filterTypes: [\"message.attempt.failing\"],\n metadata: {}\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .operational_webhook()\n .endpoint()\n .update(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n OperationalWebhookEndpointUpdate {\n description: Some(\"An example endpoint name\".to_string()),\n rate_limit: Some(1),\n uid: Some(\"unique-identifier\".to_string()),\n url: \"https://example.com/webhook/\".to_string(),\n disabled: Some(true),\n filter_types: Some(vec![\"message.attempt.failing\".to_string()]),\n metadata: Some(HashMap::new()),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.OperationalWebhook.Endpoint.Update(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new OperationalWebhookEndpointUpdate\n {\n Description = \"An example endpoint name\",\n RateLimit = 1,\n Uid = \"unique-identifier\",\n Url = \"https://example.com/webhook/\",\n Disabled = true,\n FilterTypes = [\"message.attempt.failing\"],\n Metadata = [],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->operationalWebhook->endpoint->update(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n OperationalWebhookEndpointUpdate::create(\n url: \"https://example.com/webhook/\"\n )\n ->withDescription(\"An example endpoint name\")\n ->withRateLimit(1)\n ->withUid(\"unique-identifier\")\n ->withDisabled(true)\n ->withFilterTypes([\"message.attempt.failing\"])\n ->withMetadata([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix operational-webhook endpoint update \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"description\": \"An example endpoint name\",\n \"disabled\": true,\n \"filterTypes\": [\n \"message.attempt.failing\"\n ],\n \"metadata\": {},\n \"rateLimit\": 1,\n \"uid\": \"unique-identifier\",\n \"url\": \"https://example.com/webhook/\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PUT' \\\n 'https://api.eu.svix.com/api/v1/operational-webhook/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"description\": \"An example endpoint name\",\n \"disabled\": true,\n \"filterTypes\": [\n \"message.attempt.failing\"\n ],\n \"metadata\": {},\n \"rateLimit\": 1,\n \"uid\": \"unique-identifier\",\n \"url\": \"https://example.com/webhook/\"\n }'"
}
]
},
"delete": {
"tags": [
"Webhook Endpoint"
],
"summary": "Delete Operational Webhook Endpoint",
"description": "Delete an operational webhook endpoint.",
"operationId": "v1.operational-webhook.endpoint.delete",
"parameters": [
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.operationalWebhook.endpoint.delete(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.operationalWebhook.endpoint.delete(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.operational_webhook.endpoint.delete(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.operational_webhook.endpoint.delete(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.OperationalWebhook.Endpoint.Delete(ctx, \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.operationalWebhook.endpoint.delete(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getOperationalWebhook().getEndpoint().delete(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.operational_webhook.endpoint.delete(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.operational_webhook()\n .endpoint()\n .delete(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string())\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.OperationalWebhook.Endpoint.Delete(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->operationalWebhook->endpoint->delete(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix operational-webhook endpoint delete \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'DELETE' \\\n 'https://api.eu.svix.com/api/v1/operational-webhook/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
}
},
"/api/v1/operational-webhook/endpoint/{endpoint_id}/headers": {
"get": {
"tags": [
"Webhook Endpoint"
],
"summary": "Get Operational Webhook Endpoint Headers",
"description": "Get the additional headers to be sent with the operational webhook.",
"operationId": "v1.operational-webhook.endpoint.get-headers",
"parameters": [
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationalWebhookEndpointHeadersOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.operationalWebhook.endpoint.getHeaders(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.operationalWebhook.endpoint.getHeaders(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.operational_webhook.endpoint.get_headers(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.operational_webhook.endpoint.get_headers(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.OperationalWebhook.Endpoint.GetHeaders(\n\tctx,\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.operationalWebhook.endpoint.getHeaders(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response =\n svix.getOperationalWebhook().getEndpoint().getHeaders(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.operational_webhook.endpoint.get_headers(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .operational_webhook()\n .endpoint()\n .get_headers(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string())\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.OperationalWebhook.Endpoint.GetHeaders(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->operationalWebhook->endpoint->getHeaders(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix operational-webhook endpoint get-headers \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/operational-webhook/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/headers' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"put": {
"tags": [
"Webhook Endpoint"
],
"summary": "Update Operational Webhook Endpoint Headers",
"description": "Set the additional headers to be sent with the operational webhook.",
"operationId": "v1.operational-webhook.endpoint.update-headers",
"parameters": [
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationalWebhookEndpointHeadersIn"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.operationalWebhook.endpoint.updateHeaders(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\", {\n headers: { \"X-Example\": \"123\", \"X-Foobar\": \"Bar\" },\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.operationalWebhook.endpoint.updateHeaders(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\", {\n headers: { \"X-Example\": \"123\", \"X-Foobar\": \"Bar\" },\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.operational_webhook.endpoint.update_headers(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n OperationalWebhookEndpointHeadersIn(\n headers={\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.operational_webhook.endpoint.update_headers(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n OperationalWebhookEndpointHeadersIn(\n headers={\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.OperationalWebhook.Endpoint.UpdateHeaders(\n\tctx,\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tOperationalWebhookEndpointHeadersIn{\n\t\tHeaders: map[string]string{\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.operationalWebhook.endpoint.updateHeaders(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n OperationalWebhookEndpointHeadersIn(headers = mapOf(\"X-Example\" to \"123\", \"X-Foobar\" to \"Bar\")),\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getOperationalWebhook()\n .getEndpoint()\n .updateHeaders(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new OperationalWebhookEndpointHeadersIn()\n .headers(\n Map.ofEntries(Map.entry(\"X-Example\", \"123\"), Map.entry(\"X-Foobar\", \"Bar\"))));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .operational_webhook\n .endpoint\n .update_headers(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\", {headers: {:\"X-Example\" => \"123\", :\"X-Foobar\" => \"Bar\"}})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.operational_webhook()\n .endpoint()\n .update_headers(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n OperationalWebhookEndpointHeadersIn {\n headers: HashMap::from([\n (\"X-Example\".to_string(), \"123\".to_string()),\n (\"X-Foobar\".to_string(), \"Bar\".to_string()),\n ]),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.OperationalWebhook.Endpoint.UpdateHeaders(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new OperationalWebhookEndpointHeadersIn\n {\n Headers = new() { { \"X-Example\", \"123\" }, { \"X-Foobar\", \"Bar\" } },\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->operationalWebhook->endpoint->updateHeaders(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n OperationalWebhookEndpointHeadersIn::create(\n headers: [\"X-Example\" => \"123\", \"X-Foobar\" => \"Bar\"]\n )\n\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix operational-webhook endpoint update-headers \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"headers\": {\n \"X-Example\": \"123\",\n \"X-Foobar\": \"Bar\"\n }\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PUT' \\\n 'https://api.eu.svix.com/api/v1/operational-webhook/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/headers' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"headers\": {\n \"X-Example\": \"123\",\n \"X-Foobar\": \"Bar\"\n }\n }'"
}
]
}
},
"/api/v1/operational-webhook/endpoint/{endpoint_id}/secret": {
"get": {
"tags": [
"Webhook Endpoint"
],
"summary": "Get Operational Webhook Endpoint Secret",
"description": "Get an operational webhook endpoint's signing secret.\n\nThis is used to verify the authenticity of the webhook.\nFor more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).",
"operationId": "v1.operational-webhook.endpoint.get-secret",
"parameters": [
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationalWebhookEndpointSecretOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.operationalWebhook.endpoint.getSecret(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.operationalWebhook.endpoint.getSecret(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.operational_webhook.endpoint.get_secret(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.operational_webhook.endpoint.get_secret(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.OperationalWebhook.Endpoint.GetSecret(\n\tctx,\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.operationalWebhook.endpoint.getSecret(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response =\n svix.getOperationalWebhook().getEndpoint().getSecret(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.operational_webhook.endpoint.get_secret(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .operational_webhook()\n .endpoint()\n .get_secret(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string())\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.OperationalWebhook.Endpoint.GetSecret(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->operationalWebhook->endpoint->getSecret(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix operational-webhook endpoint get-secret \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/operational-webhook/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/secret' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/operational-webhook/endpoint/{endpoint_id}/secret/rotate": {
"post": {
"tags": [
"Webhook Endpoint"
],
"summary": "Rotate Operational Webhook Endpoint Secret",
"description": "Rotates an operational webhook endpoint's signing secret.\n\nThe previous secret will remain valid for the next 24 hours.",
"operationId": "v1.operational-webhook.endpoint.rotate-secret",
"parameters": [
{
"in": "path",
"name": "endpoint_id",
"description": "The Endpoint's ID or UID.",
"required": true,
"schema": {
"description": "The Endpoint's ID or UID.",
"type": "string",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationalWebhookEndpointSecretIn"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.operationalWebhook.endpoint.rotateSecret(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\", {\n key: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.operationalWebhook.endpoint.rotateSecret(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\", {\n key: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.operational_webhook.endpoint.rotate_secret(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n OperationalWebhookEndpointSecretIn(\n key=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.operational_webhook.endpoint.rotate_secret(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n OperationalWebhookEndpointSecretIn(\n key=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.OperationalWebhook.Endpoint.RotateSecret(\n\tctx,\n\t\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n\tOperationalWebhookEndpointSecretIn{Key: ptr(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.operationalWebhook.endpoint.rotateSecret(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n OperationalWebhookEndpointSecretIn(key = \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"),\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getOperationalWebhook()\n .getEndpoint()\n .rotateSecret(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new OperationalWebhookEndpointSecretIn().key(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .operational_webhook\n .endpoint\n .rotate_secret(\"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\", {key: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.operational_webhook()\n .endpoint()\n .rotate_secret(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\".to_string(),\n OperationalWebhookEndpointSecretIn {\n key: Some(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\".to_string()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.OperationalWebhook.Endpoint.RotateSecret(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new OperationalWebhookEndpointSecretIn { Key = \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\" }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->operationalWebhook->endpoint->rotateSecret(\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n OperationalWebhookEndpointSecretIn::create()\n ->withKey(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix operational-webhook endpoint rotate-secret \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\" '{\n \"key\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/operational-webhook/endpoint/ep_33ZIBDmz66FcPG35FnsbM6Ie4X1/secret/rotate' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"key\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n }'"
}
]
}
},
"/api/v1/stats/usage/app": {
"post": {
"tags": [
"Statistics"
],
"summary": "Aggregate App Stats",
"description": "Creates a background task to calculate the message destinations for all applications in the environment.\n\nNote that this endpoint is asynchronous. You will need to poll the `Get Background Task` endpoint to\nretrieve the results of the operation.\n\nThe completed background task will return a payload like the following:\n```json\n{\n \"id\": \"qtask_33qe39Stble9Rn3ZxFrqL5ZSsjT\",\n \"status\": \"finished\",\n \"task\": \"application.stats\",\n \"data\": {\n \"appStats\": [\n {\n \"messageDestinations\": 2,\n \"appId\": \"app_33W1An2Zz5cO9SWbhHsYyDmVC6m\",\n \"appUid\": null\n }\n ]\n }\n}\n```",
"operationId": "v1.statistics.aggregate-app-stats",
"parameters": [
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppUsageStatsIn"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppUsageStatsOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.statistics.aggregateAppStats({\n since: new Date(\"2025-10-02T20:28:42+00:00\"),\n until: new Date(\"2025-10-02T20:28:42+00:00\"),\n appIds: [],\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.statistics.aggregateAppStats({\n since: new Date(\"2025-10-02T20:28:42+00:00\"),\n until: new Date(\"2025-10-02T20:28:42+00:00\"),\n appIds: [],\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.statistics.aggregate_app_stats(\n AppUsageStatsIn(\n since=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n until=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n app_ids=[],\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.statistics.aggregate_app_stats(\n AppUsageStatsIn(\n since=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n until=datetime.fromisoformat(\"2025-10-02T20:28:42+00:00\"),\n app_ids=[],\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Statistics.AggregateAppStats(\n\tctx,\n\tAppUsageStatsIn{\n\t\tSince: time.Date(2025, 10, 2, 20, 28, 42, 0, time.UTC),\n\t\tUntil: time.Date(2025, 10, 2, 20, 28, 42, 0, time.UTC),\n\t\tAppIds: []string{},\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.statistics.aggregateAppStats(\n AppUsageStatsIn(\n since = Instant.parse(\"2025-10-02T20:28:42+00:00\"),\n until = Instant.parse(\"2025-10-02T20:28:42+00:00\"),\n appIds = setOf(),\n )\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStatistics()\n .aggregateAppStats(new AppUsageStatsIn()\n .since(OffsetDateTime.parse(\"2025-10-02T20:28:42+00:00\"))\n .until(OffsetDateTime.parse(\"2025-10-02T20:28:42+00:00\"))\n .appIds(Set.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .statistics\n .aggregate_app_stats({since: \"2025-10-02T20:28:42+00:00\", until: \"2025-10-02T20:28:42+00:00\", appIds: []})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .statistics()\n .aggregate_app_stats(\n AppUsageStatsIn {\n since: \"2025-10-02T20:28:42+00:00\".to_string(),\n until: \"2025-10-02T20:28:42+00:00\".to_string(),\n app_ids: Some(vec![]),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Statistics.AggregateAppStats(\n new AppUsageStatsIn\n {\n Since = DateTime.Parse(\"2025-10-02T20:28:42+00:00\"),\n Until = DateTime.Parse(\"2025-10-02T20:28:42+00:00\"),\n AppIds = [],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->statistics->aggregateAppStats(\n AppUsageStatsIn::create(\n since: new DateTimeImmutable(\"2025-10-02T20:28:42+00:00\"),\n until: new DateTimeImmutable(\"2025-10-02T20:28:42+00:00\")\n )\n ->withAppIds([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix statistics aggregate-app-stats '{\n \"appIds\": [],\n \"since\": \"2025-10-02T20:28:42+00:00\",\n \"until\": \"2025-10-02T20:28:42+00:00\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/stats/usage/app' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"appIds\": [],\n \"since\": \"2025-10-02T20:28:42+00:00\",\n \"until\": \"2025-10-02T20:28:42+00:00\"\n }'"
}
]
}
},
"/api/v1/stats/usage/event-types": {
"put": {
"tags": [
"Statistics"
],
"summary": "Aggregate Event Types",
"description": "Creates a background task to calculate the listed event types for all apps in the organization.\n\nNote that this endpoint is asynchronous. You will need to poll the `Get Background Task` endpoint to\nretrieve the results of the operation.\n\nThe completed background task will return a payload like the following:\n```json\n{\n \"id\": \"qtask_33qe39Stble9Rn3ZxFrqL5ZSsjT\",\n \"status\": \"finished\",\n \"task\": \"event-type.aggregate\",\n \"data\": {\n \"event_types\": [\n {\n \"appId\": \"app_33W1An2Zz5cO9SWbhHsYyDmVC6m\",\n \"explicitlySubscribedEventTypes\": [\"user.signup\", \"user.deleted\"],\n \"hasCatchAllEndpoint\": false\n }\n ]\n }\n}\n```",
"operationId": "v1.statistics.aggregate-event-types",
"responses": {
"202": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregateEventTypesOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.statistics.aggregateEventTypes();"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.statistics.aggregateEventTypes();"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.statistics.aggregate_event_types()"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.statistics.aggregate_event_types()"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Statistics.AggregateEventTypes(ctx)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.statistics.aggregateEventTypes()"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStatistics().aggregateEventTypes();"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.statistics.aggregate_event_types"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.statistics().aggregate_event_types().await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Statistics.AggregateEventTypes();"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->statistics->aggregateEventTypes();"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix statistics aggregate-event-types"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PUT' \\\n 'https://api.eu.svix.com/api/v1/stats/usage/event-types' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/stream": {
"get": {
"tags": [
"Stream"
],
"summary": "List Streams",
"description": "List of all the organization's streams.",
"operationId": "v1.streaming.stream.list",
"parameters": [
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 27,
"minLength": 27,
"pattern": "^strm_[A-Za-z0-9]{22}$",
"nullable": true,
"example": "strm_2yZwUhtgs5Ai8T9yRQJXA"
},
"style": "form"
},
{
"in": "query",
"name": "order",
"description": "The sorting order of the returned items",
"schema": {
"description": "The sorting order of the returned items",
"$ref": "#/components/schemas/Ordering",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_StreamOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.stream.list();"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.stream.list();"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.stream.list()"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.stream.list()"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Stream.List(ctx, nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.streaming.stream.list()"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming().getStream().list();"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.stream.list"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.streaming().stream().list(None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Stream.List();"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->stream->list();"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming stream list"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/stream' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"post": {
"tags": [
"Stream"
],
"summary": "Create Stream",
"description": "Creates a new stream.",
"operationId": "v1.streaming.stream.create",
"parameters": [
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamIn"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.stream.create({\n name: \"sample string\",\n uid: \"unique-identifier\",\n metadata: {},\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.stream.create({\n name: \"sample string\",\n uid: \"unique-identifier\",\n metadata: {},\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.stream.create(\n StreamIn(\n name=\"sample string\",\n uid=\"unique-identifier\",\n metadata={},\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.stream.create(\n StreamIn(\n name=\"sample string\",\n uid=\"unique-identifier\",\n metadata={},\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Stream.Create(\n\tctx,\n\tStreamIn{Name: \"sample string\", Uid: ptr(\"unique-identifier\"), Metadata: nil},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.stream.create(\n StreamIn(name = \"sample string\", uid = \"unique-identifier\", metadata = mapOf())\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getStream()\n .create(new StreamIn().name(\"sample string\").uid(\"unique-identifier\").metadata(Map.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.stream.create({name: \"sample string\", uid: \"unique-identifier\", metadata: {}})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .stream()\n .create(\n StreamIn {\n name: \"sample string\".to_string(),\n uid: Some(\"unique-identifier\".to_string()),\n metadata: Some(HashMap::new()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Stream.Create(\n new StreamIn\n {\n Name = \"sample string\",\n Uid = \"unique-identifier\",\n Metadata = [],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->stream->create(\n StreamIn::create(\n name: \"sample string\"\n )\n ->withUid(\"unique-identifier\")\n ->withMetadata([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming stream create '{\n \"metadata\": {},\n \"name\": \"sample string\",\n \"uid\": \"unique-identifier\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/stream' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"metadata\": {},\n \"name\": \"sample string\",\n \"uid\": \"unique-identifier\"\n }'"
}
]
}
},
"/api/v1/stream/event-type": {
"get": {
"tags": [
"Stream Event Type"
],
"summary": "List Stream Event Types",
"description": "List of all the organization's event types for streaming.",
"operationId": "v1.streaming.event-type.list",
"parameters": [
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"nullable": true,
"example": "user.signup"
},
"style": "form"
},
{
"in": "query",
"name": "order",
"description": "The sorting order of the returned items",
"schema": {
"description": "The sorting order of the returned items",
"$ref": "#/components/schemas/Ordering",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "include_archived",
"description": "Include archived (deleted but not expunged) items in the response.",
"schema": {
"description": "Include archived (deleted but not expunged) items in the response.",
"default": false,
"type": "boolean"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_StreamEventTypeOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.eventType.list();"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.eventType.list();"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.event_type.list()"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.event_type.list()"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.EventType.List(ctx, nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.streaming.eventType.list()"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming().getEventType().list();"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.event_type.list"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.streaming().event_type().list(None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.EventType.List();"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->eventType->list();"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming event-type list"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/stream/event-type' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"post": {
"tags": [
"Stream Event Type"
],
"summary": "Create Stream Event Type",
"description": "Create an event type for Streams.",
"operationId": "v1.streaming.event-type.create",
"parameters": [
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamEventTypeIn"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamEventTypeOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.eventType.create({\n name: \"user.signup\",\n description: \"sample string\",\n featureFlags: [\"cool-new-feature\"],\n deprecated: true,\n archived: true,\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.eventType.create({\n name: \"user.signup\",\n description: \"sample string\",\n featureFlags: [\"cool-new-feature\"],\n deprecated: true,\n archived: true,\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.event_type.create(\n StreamEventTypeIn(\n name=\"user.signup\",\n description=\"sample string\",\n feature_flags=[\n \"cool-new-feature\",\n ],\n deprecated=True,\n archived=True,\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.event_type.create(\n StreamEventTypeIn(\n name=\"user.signup\",\n description=\"sample string\",\n feature_flags=[\n \"cool-new-feature\",\n ],\n deprecated=True,\n archived=True,\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.EventType.Create(\n\tctx,\n\tStreamEventTypeIn{\n\t\tName: \"user.signup\",\n\t\tDescription: ptr(\"sample string\"),\n\t\tFeatureFlags: []string{\"cool-new-feature\"},\n\t\tDeprecated: ptr(true),\n\t\tArchived: ptr(true),\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.eventType.create(\n StreamEventTypeIn(\n name = \"user.signup\",\n description = \"sample string\",\n featureFlags = setOf(\"cool-new-feature\"),\n deprecated = true,\n archived = true,\n )\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getEventType()\n .create(new StreamEventTypeIn()\n .name(\"user.signup\")\n .description(\"sample string\")\n .featureFlags(Set.of(\"cool-new-feature\"))\n .deprecated(true)\n .archived(true));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .streaming\n .event_type\n .create(\n {\n name: \"user.signup\",\n description: \"sample string\",\n featureFlags: [\"cool-new-feature\"],\n deprecated: true,\n archived: true\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .event_type()\n .create(\n StreamEventTypeIn {\n name: \"user.signup\".to_string(),\n description: Some(\"sample string\".to_string()),\n feature_flags: Some(vec![\"cool-new-feature\".to_string()]),\n deprecated: Some(true),\n archived: Some(true),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.EventType.Create(\n new StreamEventTypeIn\n {\n Name = \"user.signup\",\n Description = \"sample string\",\n FeatureFlags = [\"cool-new-feature\"],\n Deprecated = true,\n Archived = true,\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->eventType->create(\n StreamEventTypeIn::create(\n name: \"user.signup\"\n )\n ->withDescription(\"sample string\")\n ->withFeatureFlags([\"cool-new-feature\"])\n ->withDeprecated(true)\n ->withArchived(true)\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming event-type create '{\n \"archived\": true,\n \"deprecated\": true,\n \"description\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"name\": \"user.signup\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/stream/event-type' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"archived\": true,\n \"deprecated\": true,\n \"description\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"name\": \"user.signup\"\n }'"
}
]
}
},
"/api/v1/stream/event-type/{name}": {
"get": {
"tags": [
"Stream Event Type"
],
"summary": "Get Stream Event Type",
"description": "Get an event type.",
"operationId": "v1.streaming.event-type.get",
"parameters": [
{
"in": "path",
"name": "name",
"description": "The event type's name",
"required": true,
"schema": {
"description": "The event type's name",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "user.signup"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamEventTypeOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.eventType.get(\"name\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.eventType.get(\"name\");"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.event_type.get(\n \"name\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.event_type.get(\n \"name\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.EventType.Get(ctx, \"name\")"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.streaming.eventType.get(\"name\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming().getEventType().get(\"name\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.event_type.get(\"name\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.streaming().event_type().get(\"name\".to_string()).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.EventType.Get(\"name\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->eventType->get(\n \"name\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming event-type get \"name\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/stream/event-type/name' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"put": {
"tags": [
"Stream Event Type"
],
"summary": "Update Stream Event Type",
"description": "Update or create a event type for Streams.",
"operationId": "v1.streaming.event-type.update",
"parameters": [
{
"in": "path",
"name": "name",
"description": "The event type's name",
"required": true,
"schema": {
"description": "The event type's name",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "user.signup"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamEventTypeIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamEventTypeOut"
}
}
}
},
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamEventTypeOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.eventType.update(\"name\", {\n name: \"user.signup\",\n description: \"sample string\",\n featureFlags: [\"cool-new-feature\"],\n deprecated: true,\n archived: true,\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.eventType.update(\"name\", {\n name: \"user.signup\",\n description: \"sample string\",\n featureFlags: [\"cool-new-feature\"],\n deprecated: true,\n archived: true,\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.event_type.update(\n \"name\",\n StreamEventTypeIn(\n name=\"user.signup\",\n description=\"sample string\",\n feature_flags=[\n \"cool-new-feature\",\n ],\n deprecated=True,\n archived=True,\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.event_type.update(\n \"name\",\n StreamEventTypeIn(\n name=\"user.signup\",\n description=\"sample string\",\n feature_flags=[\n \"cool-new-feature\",\n ],\n deprecated=True,\n archived=True,\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.EventType.Update(\n\tctx,\n\t\"name\",\n\tStreamEventTypeIn{\n\t\tName: \"user.signup\",\n\t\tDescription: ptr(\"sample string\"),\n\t\tFeatureFlags: []string{\"cool-new-feature\"},\n\t\tDeprecated: ptr(true),\n\t\tArchived: ptr(true),\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.eventType.update(\n \"name\",\n StreamEventTypeIn(\n name = \"user.signup\",\n description = \"sample string\",\n featureFlags = setOf(\"cool-new-feature\"),\n deprecated = true,\n archived = true,\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getEventType()\n .update(\n \"name\",\n new StreamEventTypeIn()\n .name(\"user.signup\")\n .description(\"sample string\")\n .featureFlags(Set.of(\"cool-new-feature\"))\n .deprecated(true)\n .archived(true));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .streaming\n .event_type\n .update(\n \"name\",\n {\n name: \"user.signup\",\n description: \"sample string\",\n featureFlags: [\"cool-new-feature\"],\n deprecated: true,\n archived: true\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .event_type()\n .update(\n \"name\".to_string(),\n StreamEventTypeIn {\n name: \"user.signup\".to_string(),\n description: Some(\"sample string\".to_string()),\n feature_flags: Some(vec![\"cool-new-feature\".to_string()]),\n deprecated: Some(true),\n archived: Some(true),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.EventType.Update(\n \"name\",\n new StreamEventTypeIn\n {\n Name = \"user.signup\",\n Description = \"sample string\",\n FeatureFlags = [\"cool-new-feature\"],\n Deprecated = true,\n Archived = true,\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->eventType->update(\n \"name\",\n StreamEventTypeIn::create(\n name: \"user.signup\"\n )\n ->withDescription(\"sample string\")\n ->withFeatureFlags([\"cool-new-feature\"])\n ->withDeprecated(true)\n ->withArchived(true)\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming event-type update \"name\" '{\n \"archived\": true,\n \"deprecated\": true,\n \"description\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"name\": \"user.signup\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PUT' \\\n 'https://api.eu.svix.com/api/v1/stream/event-type/name' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"archived\": true,\n \"deprecated\": true,\n \"description\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"name\": \"user.signup\"\n }'"
}
]
},
"delete": {
"tags": [
"Stream Event Type"
],
"summary": "Delete Stream Event Type",
"description": "Delete an event type.",
"operationId": "v1.streaming.event-type.delete",
"parameters": [
{
"in": "path",
"name": "name",
"description": "The event type's name",
"required": true,
"schema": {
"description": "The event type's name",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "user.signup"
},
"style": "simple"
},
{
"in": "query",
"name": "expunge",
"description": "By default, event types are archived when \"deleted\". With this flag, they are deleted entirely.",
"schema": {
"description": "By default, event types are archived when \"deleted\". With this flag, they are deleted entirely.",
"default": false,
"type": "boolean"
},
"style": "form"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.streaming.eventType.delete(\"name\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.streaming.eventType.delete(\"name\");"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.streaming.event_type.delete(\n \"name\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.streaming.event_type.delete(\n \"name\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Streaming.EventType.Delete(ctx, \"name\", nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.streaming.eventType.delete(\n \"name\"\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getStreaming().getEventType().delete(\"name\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.event_type.delete(\"name\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.streaming().event_type().delete(\"name\".to_string(), None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.EventType.Delete(\"name\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->streaming->eventType->delete(\n \"name\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming event-type delete \"name\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'DELETE' \\\n 'https://api.eu.svix.com/api/v1/stream/event-type/name' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
},
"patch": {
"tags": [
"Stream Event Type"
],
"summary": "Patch Stream Event Type",
"description": "Patch an event type for Streams.",
"operationId": "v1.streaming.event-type.patch",
"parameters": [
{
"in": "path",
"name": "name",
"description": "The event type's name",
"required": true,
"schema": {
"description": "The event type's name",
"type": "string",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9\\-_.]+$",
"example": "user.signup"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamEventTypePatch"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamEventTypeOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.eventType.patch(\"name\", {\n name: \"user.signup\",\n description: \"sample string\",\n featureFlags: [\"cool-new-feature\"],\n deprecated: true,\n archived: true,\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.eventType.patch(\"name\", {\n name: \"user.signup\",\n description: \"sample string\",\n featureFlags: [\"cool-new-feature\"],\n deprecated: true,\n archived: true,\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.event_type.patch(\n \"name\",\n StreamEventTypePatch(\n name=\"user.signup\",\n description=\"sample string\",\n feature_flags=[\n \"cool-new-feature\",\n ],\n deprecated=True,\n archived=True,\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.event_type.patch(\n \"name\",\n StreamEventTypePatch(\n name=\"user.signup\",\n description=\"sample string\",\n feature_flags=[\n \"cool-new-feature\",\n ],\n deprecated=True,\n archived=True,\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.EventType.Patch(\n\tctx,\n\t\"name\",\n\tStreamEventTypePatch{\n\t\tName: NewNullable(\"user.signup\"),\n\t\tDescription: NewNullable(\"sample string\"),\n\t\tFeatureFlags: NewNullable([]string{\"cool-new-feature\"}),\n\t\tDeprecated: ptr(true),\n\t\tArchived: ptr(true),\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.eventType.patch(\n \"name\",\n StreamEventTypePatch(\n name = MaybeUnset.Present(\"user.signup\"),\n description = MaybeUnset.Present(\"sample string\"),\n featureFlags = MaybeUnset.Present(setOf(\"cool-new-feature\")),\n deprecated = true,\n archived = true,\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getEventType()\n .patch(\n \"name\",\n new StreamEventTypePatch()\n .name(\"user.signup\")\n .description(\"sample string\")\n .featureFlags(Set.of(\"cool-new-feature\"))\n .deprecated(true)\n .archived(true));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .streaming\n .event_type\n .patch(\n \"name\",\n {\n name: \"user.signup\",\n description: \"sample string\",\n featureFlags: [\"cool-new-feature\"],\n deprecated: true,\n archived: true\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .event_type()\n .patch(\n \"name\".to_string(),\n StreamEventTypePatch {\n name: js_option::JsOption::Some(\"user.signup\".to_string()),\n description: js_option::JsOption::Some(\"sample string\".to_string()),\n feature_flags: js_option::JsOption::Some(\n vec![\"cool-new-feature\".to_string()],\n ),\n deprecated: Some(true),\n archived: Some(true),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.EventType.Patch(\n \"name\",\n new StreamEventTypePatch\n {\n Name = \"user.signup\",\n Description = \"sample string\",\n FeatureFlags = MaybeUnset<List<string>?>.Set([\"cool-new-feature\"]),\n Deprecated = true,\n Archived = true,\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->eventType->patch(\n \"name\",\n StreamEventTypePatch::create()\n ->withName(\"user.signup\")\n ->withDescription(\"sample string\")\n ->withFeatureFlags([\"cool-new-feature\"])\n ->withDeprecated(true)\n ->withArchived(true)\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming event-type patch \"name\" '{\n \"archived\": true,\n \"deprecated\": true,\n \"description\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"name\": \"user.signup\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PATCH' \\\n 'https://api.eu.svix.com/api/v1/stream/event-type/name' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"archived\": true,\n \"deprecated\": true,\n \"description\": \"sample string\",\n \"featureFlags\": [\n \"cool-new-feature\"\n ],\n \"name\": \"user.signup\"\n }'"
}
]
}
},
"/api/v1/stream/{stream_id}": {
"get": {
"tags": [
"Stream"
],
"summary": "Get Stream",
"description": "Get a stream by id or uid.",
"operationId": "v1.streaming.stream.get",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.stream.get(\"strm_31Dc0DD72P5AddYUguyBd\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.stream.get(\"strm_31Dc0DD72P5AddYUguyBd\");"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.stream.get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.stream.get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Stream.Get(ctx, \"strm_31Dc0DD72P5AddYUguyBd\")"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.streaming.stream.get(\"strm_31Dc0DD72P5AddYUguyBd\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming().getStream().get(\"strm_31Dc0DD72P5AddYUguyBd\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.stream.get(\"strm_31Dc0DD72P5AddYUguyBd\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .stream()\n .get(\"strm_31Dc0DD72P5AddYUguyBd\".to_string())\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Stream.Get(\"strm_31Dc0DD72P5AddYUguyBd\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->stream->get(\n \"strm_31Dc0DD72P5AddYUguyBd\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming stream get \"strm_31Dc0DD72P5AddYUguyBd\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"put": {
"tags": [
"Stream"
],
"summary": "Update Stream",
"description": "Update a stream.",
"operationId": "v1.streaming.stream.update",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamOut"
}
}
}
},
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.stream.update(\"strm_31Dc0DD72P5AddYUguyBd\", {\n name: \"sample string\",\n uid: \"unique-identifier\",\n metadata: {},\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.stream.update(\"strm_31Dc0DD72P5AddYUguyBd\", {\n name: \"sample string\",\n uid: \"unique-identifier\",\n metadata: {},\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.stream.update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamIn(\n name=\"sample string\",\n uid=\"unique-identifier\",\n metadata={},\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.stream.update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamIn(\n name=\"sample string\",\n uid=\"unique-identifier\",\n metadata={},\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Stream.Update(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\tStreamIn{Name: \"sample string\", Uid: ptr(\"unique-identifier\"), Metadata: nil},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.stream.update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamIn(name = \"sample string\", uid = \"unique-identifier\", metadata = mapOf()),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getStream()\n .update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n new StreamIn().name(\"sample string\").uid(\"unique-identifier\").metadata(Map.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .streaming\n .stream\n .update(\"strm_31Dc0DD72P5AddYUguyBd\", {name: \"sample string\", uid: \"unique-identifier\", metadata: {}})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .stream()\n .update(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n StreamIn {\n name: \"sample string\".to_string(),\n uid: Some(\"unique-identifier\".to_string()),\n metadata: Some(HashMap::new()),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Stream.Update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n new StreamIn\n {\n Name = \"sample string\",\n Uid = \"unique-identifier\",\n Metadata = [],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->stream->update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamIn::create(\n name: \"sample string\"\n )\n ->withUid(\"unique-identifier\")\n ->withMetadata([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming stream update \"strm_31Dc0DD72P5AddYUguyBd\" '{\n \"metadata\": {},\n \"name\": \"sample string\",\n \"uid\": \"unique-identifier\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PUT' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"metadata\": {},\n \"name\": \"sample string\",\n \"uid\": \"unique-identifier\"\n }'"
}
]
},
"delete": {
"tags": [
"Stream"
],
"summary": "Delete Stream",
"description": "Delete a stream.",
"operationId": "v1.streaming.stream.delete",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.streaming.stream.delete(\"strm_31Dc0DD72P5AddYUguyBd\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.streaming.stream.delete(\"strm_31Dc0DD72P5AddYUguyBd\");"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.streaming.stream.delete(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.streaming.stream.delete(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Streaming.Stream.Delete(ctx, \"strm_31Dc0DD72P5AddYUguyBd\")"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.streaming.stream.delete(\n \"strm_31Dc0DD72P5AddYUguyBd\"\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getStreaming().getStream().delete(\"strm_31Dc0DD72P5AddYUguyBd\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.stream.delete(\"strm_31Dc0DD72P5AddYUguyBd\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.streaming().stream().delete(\"strm_31Dc0DD72P5AddYUguyBd\".to_string()).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Stream.Delete(\"strm_31Dc0DD72P5AddYUguyBd\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->streaming->stream->delete(\n \"strm_31Dc0DD72P5AddYUguyBd\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming stream delete \"strm_31Dc0DD72P5AddYUguyBd\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'DELETE' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
},
"patch": {
"tags": [
"Stream"
],
"summary": "Patch Stream",
"description": "Partially update a stream.",
"operationId": "v1.streaming.stream.patch",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.stream.patch(\"strm_31Dc0DD72P5AddYUguyBd\", {\n description: \"sample string\",\n uid: \"unique-identifier\",\n metadata: {},\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.stream.patch(\"strm_31Dc0DD72P5AddYUguyBd\", {\n description: \"sample string\",\n uid: \"unique-identifier\",\n metadata: {},\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.stream.patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamPatch(\n description=\"sample string\",\n uid=\"unique-identifier\",\n metadata={},\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.stream.patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamPatch(\n description=\"sample string\",\n uid=\"unique-identifier\",\n metadata={},\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Stream.Patch(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\tStreamPatch{\n\t\tDescription: ptr(\"sample string\"),\n\t\tUid: NewNullable(\"unique-identifier\"),\n\t\tMetadata: nil,\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.stream.patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamPatch(\n description = \"sample string\",\n uid = MaybeUnset.Present(\"unique-identifier\"),\n metadata = mapOf(),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getStream()\n .patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n new StreamPatch()\n .description(\"sample string\")\n .uid(\"unique-identifier\")\n .metadata(Map.of()));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .streaming\n .stream\n .patch(\"strm_31Dc0DD72P5AddYUguyBd\", {description: \"sample string\", uid: \"unique-identifier\", metadata: {}})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .stream()\n .patch(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n StreamPatch {\n description: Some(\"sample string\".to_string()),\n uid: js_option::JsOption::Some(\"unique-identifier\".to_string()),\n metadata: Some(HashMap::new()),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Stream.Patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n new StreamPatch\n {\n Description = \"sample string\",\n Uid = \"unique-identifier\",\n Metadata = [],\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->stream->patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamPatch::create()\n ->withDescription(\"sample string\")\n ->withUid(\"unique-identifier\")\n ->withMetadata([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming stream patch \"strm_31Dc0DD72P5AddYUguyBd\" '{\n \"description\": \"sample string\",\n \"metadata\": {},\n \"uid\": \"unique-identifier\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PATCH' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"description\": \"sample string\",\n \"metadata\": {},\n \"uid\": \"unique-identifier\"\n }'"
}
]
}
},
"/api/v1/stream/{stream_id}/events": {
"post": {
"tags": [
"Event"
],
"summary": "Create Events",
"description": "Creates events on the Stream.",
"operationId": "v1.streaming.events.create",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateStreamEventsIn"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateStreamEventsOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "Javascript",
"source": "await svix.streaming.events.create(\"rock_inc_uid\", {\n events: [\n {\n \"eventType\": \"user.signup\",\n \"payload\": '{\"email\":\"test@example.com\",\"username\":\"test_user\"}'\n }\n ]\n});"
},
{
"label": "TypeScript",
"lang": "Typescript",
"source": "await svix.streaming.events.create(\"rock_inc_uid\", {\n events: [\n {\n \"eventType\": \"user.signup\",\n \"payload\": '{\"email\":\"test@example.com\",\"username\":\"test_user\"}'\n }\n ]\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.streaming.events.create(\"rock_inc_uid\", CreateStreamEventsIn(\n events=[\n EventIn(\n eventType=\"user.signup\",\n payload='{\"email\":\"test@example.com\",\"username\":\"test_user\"}'\n )\n ]\n))"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.streaming.events.create(\"rock_inc_uid\", CreateStreamEventsIn(\n events=[\n EventIn(\n eventType=\"user.signup\",\n payload='{\"email\":\"test@example.com\",\"username\":\"test_user\"}'\n )\n ]\n))"
},
{
"label": "Go",
"lang": "Go",
"source": "svixClient.Streaming.Events.Create(\n ctx,\n \"rock_inc_uid\",\n &svix.CreateStreamEventsIn{\n Events: []svix.EventIn{\n {\n EventType: \"user.signup\",\n Payload: \\`{\"email\":\"test@example.com\",\"username\":\"test_user\"}\\`,\n }\n },\n })"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.streaming.events.create(\"rock_inc_uid\", CreateStreamEventsIn()\n .events(arrayOf(\n EventIn(\n eventType = \"user.signup\",\n payload = \\`{\"email\":\"test@example.com\",\"username\":\"test_user\"}\\`,\n )\n ))\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getStream().getEvents().create(\"rock_inc_uid\", new CreateStreamEventsIn()\n .events(new EventIn[]{\n new EventIn()\n .eventType(\"user.signup\")\n .payload(\"{\\\"email\\\":\\\"test@example.com\\\",\\\"username\\\":\\\"test_user\\\"}\")\n })\n);"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "svix.streaming.events.create(\"rock_inc_uid\", Svix::CreateStreamEventsIn.new({\n \"events\": [\n {\n \"eventType\": \"user.signup\",\n \"payload\": '{\"email\":\"test@example.com\",\"username\":\"test_user\"}'\n }\n ]\n}))"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.streaming().events().create(\"rock_inc_uid\", CreateStreamEventsIn {\n events: vec![\n EventIn {\n event_type: \"user.signup\".into(),\n payload: r#\"{\"email\":\"test@example.com\",\"username\":\"test_user\"}\"#.into()\n }\n ],\n stream: None,\n}, None).await?;"
},
{
"label": "Php",
"lang": "Php",
"source": "$svix->streaming->events->create(\n 'rock_inc_uid',\n CreateStreamEventsIn::create(\n events: [\n [\n 'eventType' => 'user.signup',\n 'payload' => '{\"email\":\"test@example.com\",\"username\":\"test_user\"}'\n ]\n ],\n )\n);"
},
{
"label": "C#",
"lang": "C#",
"source": "await svix.Streaming.Events.CreateAsync(\"stream_id\", new CreateStreamEventsIn{\n events: new EventIn[] {\n new EventIn(\n eventType: \"user.signup\",\n payload: \"{\\\\\"email\\\\\":\\\\\"test@example.com\\\\\",\\\\\"username\\\\\":\\\\\"test_user\\\\\"}\"\n )\n }\n});"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\\\n 'https://api.svix.com/api/v1/stream/rock_inc_uid/events' \\\\\n -H 'accept: application/json' \\\\\n -H \"Authorization: Bearer \\${AUTH_TOKEN}\" \\\\\n -H 'Content-Type: application/json' \\\\\n -d '{\n \"events\": [\n {\n \"eventType\":\"user.signup\",\n \"payload\":\"{\\\\\"email\\\":\\\\\"test@example.com\\\\\",\\\\\"username\\\\\":\\\\\"test_user\\\\\"}\"\n }\n ],\n}'"
},
{
"label": "CLI",
"lang": "CLI",
"source": "Coming soon to Svix CLI"
}
]
}
},
"/api/v1/stream/{stream_id}/sink": {
"get": {
"tags": [
"Sink"
],
"summary": "List Sinks",
"description": "List of all the stream's sinks.",
"operationId": "v1.streaming.sink.list",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 27,
"minLength": 27,
"pattern": "^sink_[A-Za-z0-9]{22}$",
"nullable": true,
"example": "sink_2yZwUhtgs5Ai8T9yRQJXA"
},
"style": "form"
},
{
"in": "query",
"name": "order",
"description": "The sorting order of the returned items",
"schema": {
"description": "The sorting order of the returned items",
"$ref": "#/components/schemas/Ordering",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_StreamSinkOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.sink.list(\"strm_31Dc0DD72P5AddYUguyBd\");"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.sink.list(\"strm_31Dc0DD72P5AddYUguyBd\");"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.sink.list(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.sink.list(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Sink.List(ctx, \"strm_31Dc0DD72P5AddYUguyBd\", nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.streaming.sink.list(\"strm_31Dc0DD72P5AddYUguyBd\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming().getSink().list(\"strm_31Dc0DD72P5AddYUguyBd\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.sink.list(\"strm_31Dc0DD72P5AddYUguyBd\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .sink()\n .list(\"strm_31Dc0DD72P5AddYUguyBd\".to_string(), None)\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Sink.List(\"strm_31Dc0DD72P5AddYUguyBd\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->sink->list(\n \"strm_31Dc0DD72P5AddYUguyBd\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming sink list \"strm_31Dc0DD72P5AddYUguyBd\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"post": {
"tags": [
"Sink"
],
"summary": "Create Sink",
"description": "Creates a new sink.",
"operationId": "v1.streaming.sink.create",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamSinkIn"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamSinkOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.sink.create(\"strm_31Dc0DD72P5AddYUguyBd\", {\n uid: \"unique-identifier\",\n status: SinkStatusIn.Enabled,\n batchSize: 100,\n maxWaitSecs: 1,\n eventTypes: [],\n metadata: {},\n type: \"azureBlobStorage\",\n config: {\n container: \"sample string\",\n account: \"sample string\",\n accessKey: \"sample string\",\n },\n});"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.sink.create(\"strm_31Dc0DD72P5AddYUguyBd\", {\n uid: \"unique-identifier\",\n status: SinkStatusIn.Enabled,\n batchSize: 100,\n maxWaitSecs: 1,\n eventTypes: [],\n metadata: {},\n type: \"azureBlobStorage\",\n config: {\n container: \"sample string\",\n account: \"sample string\",\n accessKey: \"sample string\",\n },\n});"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.sink.create(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamSinkIn(\n uid=\"unique-identifier\",\n status=SinkStatusIn.ENABLED,\n batch_size=100,\n max_wait_secs=1,\n event_types=[],\n metadata={},\n type=\"azureBlobStorage\",\n config=AzureBlobStorageConfig(\n container=\"sample string\",\n account=\"sample string\",\n access_key=\"sample string\",\n ),\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.sink.create(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamSinkIn(\n uid=\"unique-identifier\",\n status=SinkStatusIn.ENABLED,\n batch_size=100,\n max_wait_secs=1,\n event_types=[],\n metadata={},\n type=\"azureBlobStorage\",\n config=AzureBlobStorageConfig(\n container=\"sample string\",\n account=\"sample string\",\n access_key=\"sample string\",\n ),\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Sink.Create(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\tStreamSinkIn{\n\t\tUid: ptr(\"unique-identifier\"),\n\t\tStatus: ptr(SINKSTATUSIN_ENABLED),\n\t\tBatchSize: ptr(uint16(100)),\n\t\tMaxWaitSecs: ptr(uint16(1)),\n\t\tEventTypes: []string{},\n\t\tMetadata: nil,\n\t\tConfig: (AzureBlobStorageConfig{Container: \"sample string\", Account: \"sample string\", AccessKey: \"sample string\"}),\n\t\tType: \"azureBlobStorage\",\n\t},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.sink.create(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamSinkIn(\n uid = \"unique-identifier\",\n status = SinkStatusIn.ENABLED,\n batchSize = 100u,\n maxWaitSecs = 1u,\n eventTypes = listOf(),\n metadata = mapOf(),\n config =\n StreamSinkInConfig.AzureBlobStorage(\n AzureBlobStorageConfig(\n container = \"sample string\",\n account = \"sample string\",\n accessKey = \"sample string\",\n )\n ),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getSink()\n .create(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n new StreamSinkIn()\n .uid(\"unique-identifier\")\n .status(SinkStatusIn.ENABLED)\n .batchSize(100L)\n .maxWaitSecs(1L)\n .eventTypes(List.of())\n .metadata(Map.of())\n .config(new StreamSinkInConfig.AzureBlobStorage(new AzureBlobStorageConfig()\n .container(\"sample string\")\n .account(\"sample string\")\n .accessKey(\"sample string\"))));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .streaming\n .sink\n .create(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n {\n uid: \"unique-identifier\",\n status: SinkStatusIn::ENABLED,\n batchSize: 100,\n maxWaitSecs: 1,\n eventTypes: [],\n metadata: {},\n config: {container: \"sample string\", account: \"sample string\", accessKey: \"sample string\"},\n type: \"azureBlobStorage\"\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .sink()\n .create(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n StreamSinkIn {\n uid: Some(\"unique-identifier\".to_string()),\n status: Some(SinkStatusIn::Enabled),\n batch_size: Some(100),\n max_wait_secs: Some(1),\n event_types: Some(vec![]),\n metadata: Some(HashMap::new()),\n config: StreamSinkInConfig::AzureBlobStorage(AzureBlobStorageConfig {\n container: \"sample string\".to_string(),\n account: \"sample string\".to_string(),\n access_key: \"sample string\".to_string(),\n }),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Sink.Create(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n new StreamSinkIn\n {\n Uid = \"unique-identifier\",\n Status = SinkStatusIn.Enabled,\n BatchSize = 100,\n MaxWaitSecs = 1,\n EventTypes = [],\n Metadata = [],\n Config = StreamSinkInConfig.AzureBlobStorage(\n (\n new AzureBlobStorageConfig\n {\n Container = \"sample string\",\n Account = \"sample string\",\n AccessKey = \"sample string\",\n }\n )\n ),\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->sink->create(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n StreamSinkIn::create()\n ->withUid(\"unique-identifier\")\n ->withStatus(SinkStatusIn::ENABLED)\n ->withBatchSize(100)\n ->withMaxWaitSecs(1)\n ->withEventTypes([])\n ->withMetadata([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming sink create \"strm_31Dc0DD72P5AddYUguyBd\" '{\n \"batchSize\": 100,\n \"config\": {\n \"accessKey\": \"sample string\",\n \"account\": \"sample string\",\n \"container\": \"sample string\"\n },\n \"eventTypes\": [],\n \"maxWaitSecs\": 1,\n \"metadata\": {},\n \"status\": \"enabled\",\n \"type\": \"azureBlobStorage\",\n \"uid\": \"unique-identifier\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"batchSize\": 100,\n \"config\": {\n \"accessKey\": \"sample string\",\n \"account\": \"sample string\",\n \"container\": \"sample string\"\n },\n \"eventTypes\": [],\n \"maxWaitSecs\": 1,\n \"metadata\": {},\n \"status\": \"enabled\",\n \"type\": \"azureBlobStorage\",\n \"uid\": \"unique-identifier\"\n }'"
}
]
}
},
"/api/v1/stream/{stream_id}/sink/{sink_id}": {
"get": {
"tags": [
"Sink"
],
"summary": "Get Sink",
"description": "Get a sink by id or uid.",
"operationId": "v1.streaming.sink.get",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamSinkOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.sink.get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.sink.get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.sink.get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.sink.get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Sink.Get(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.streaming.sink.get(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getSink()\n .get(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.sink.get(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .sink()\n .get(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Sink.Get(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\");"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->sink->get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming sink get \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"put": {
"tags": [
"Sink"
],
"summary": "Update Sink",
"description": "Update a sink.",
"operationId": "v1.streaming.sink.update",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamSinkIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamSinkOut"
}
}
}
},
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamSinkOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.sink.update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n uid: \"unique-identifier\",\n status: SinkStatusIn.Enabled,\n batchSize: 100,\n maxWaitSecs: 1,\n eventTypes: [],\n metadata: {},\n type: \"azureBlobStorage\",\n config: {\n container: \"sample string\",\n account: \"sample string\",\n accessKey: \"sample string\",\n },\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.sink.update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n uid: \"unique-identifier\",\n status: SinkStatusIn.Enabled,\n batchSize: 100,\n maxWaitSecs: 1,\n eventTypes: [],\n metadata: {},\n type: \"azureBlobStorage\",\n config: {\n container: \"sample string\",\n account: \"sample string\",\n accessKey: \"sample string\",\n },\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.sink.update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n StreamSinkIn(\n uid=\"unique-identifier\",\n status=SinkStatusIn.ENABLED,\n batch_size=100,\n max_wait_secs=1,\n event_types=[],\n metadata={},\n type=\"azureBlobStorage\",\n config=AzureBlobStorageConfig(\n container=\"sample string\",\n account=\"sample string\",\n access_key=\"sample string\",\n ),\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.sink.update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n StreamSinkIn(\n uid=\"unique-identifier\",\n status=SinkStatusIn.ENABLED,\n batch_size=100,\n max_wait_secs=1,\n event_types=[],\n metadata={},\n type=\"azureBlobStorage\",\n config=AzureBlobStorageConfig(\n container=\"sample string\",\n account=\"sample string\",\n access_key=\"sample string\",\n ),\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Sink.Update(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n\tStreamSinkIn{\n\t\tUid: ptr(\"unique-identifier\"),\n\t\tStatus: ptr(SINKSTATUSIN_ENABLED),\n\t\tBatchSize: ptr(uint16(100)),\n\t\tMaxWaitSecs: ptr(uint16(1)),\n\t\tEventTypes: []string{},\n\t\tMetadata: nil,\n\t\tConfig: (AzureBlobStorageConfig{Container: \"sample string\", Account: \"sample string\", AccessKey: \"sample string\"}),\n\t\tType: \"azureBlobStorage\",\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.sink.update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n StreamSinkIn(\n uid = \"unique-identifier\",\n status = SinkStatusIn.ENABLED,\n batchSize = 100u,\n maxWaitSecs = 1u,\n eventTypes = listOf(),\n metadata = mapOf(),\n config =\n StreamSinkInConfig.AzureBlobStorage(\n AzureBlobStorageConfig(\n container = \"sample string\",\n account = \"sample string\",\n accessKey = \"sample string\",\n )\n ),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getSink()\n .update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n new StreamSinkIn()\n .uid(\"unique-identifier\")\n .status(SinkStatusIn.ENABLED)\n .batchSize(100L)\n .maxWaitSecs(1L)\n .eventTypes(List.of())\n .metadata(Map.of())\n .config(new StreamSinkInConfig.AzureBlobStorage(new AzureBlobStorageConfig()\n .container(\"sample string\")\n .account(\"sample string\")\n .accessKey(\"sample string\"))));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .streaming\n .sink\n .update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n uid: \"unique-identifier\",\n status: SinkStatusIn::ENABLED,\n batchSize: 100,\n maxWaitSecs: 1,\n eventTypes: [],\n metadata: {},\n config: {container: \"sample string\", account: \"sample string\", accessKey: \"sample string\"},\n type: \"azureBlobStorage\"\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .sink()\n .update(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n StreamSinkIn {\n uid: Some(\"unique-identifier\".to_string()),\n status: Some(SinkStatusIn::Enabled),\n batch_size: Some(100),\n max_wait_secs: Some(1),\n event_types: Some(vec![]),\n metadata: Some(HashMap::new()),\n config: StreamSinkInConfig::AzureBlobStorage(AzureBlobStorageConfig {\n container: \"sample string\".to_string(),\n account: \"sample string\".to_string(),\n access_key: \"sample string\".to_string(),\n }),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Sink.Update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n new StreamSinkIn\n {\n Uid = \"unique-identifier\",\n Status = SinkStatusIn.Enabled,\n BatchSize = 100,\n MaxWaitSecs = 1,\n EventTypes = [],\n Metadata = [],\n Config = StreamSinkInConfig.AzureBlobStorage(\n (\n new AzureBlobStorageConfig\n {\n Container = \"sample string\",\n Account = \"sample string\",\n AccessKey = \"sample string\",\n }\n )\n ),\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->sink->update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n StreamSinkIn::create()\n ->withUid(\"unique-identifier\")\n ->withStatus(SinkStatusIn::ENABLED)\n ->withBatchSize(100)\n ->withMaxWaitSecs(1)\n ->withEventTypes([])\n ->withMetadata([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming sink update \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\" '{\n \"batchSize\": 100,\n \"config\": {\n \"accessKey\": \"sample string\",\n \"account\": \"sample string\",\n \"container\": \"sample string\"\n },\n \"eventTypes\": [],\n \"maxWaitSecs\": 1,\n \"metadata\": {},\n \"status\": \"enabled\",\n \"type\": \"azureBlobStorage\",\n \"uid\": \"unique-identifier\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PUT' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"batchSize\": 100,\n \"config\": {\n \"accessKey\": \"sample string\",\n \"account\": \"sample string\",\n \"container\": \"sample string\"\n },\n \"eventTypes\": [],\n \"maxWaitSecs\": 1,\n \"metadata\": {},\n \"status\": \"enabled\",\n \"type\": \"azureBlobStorage\",\n \"uid\": \"unique-identifier\"\n }'"
}
]
},
"delete": {
"tags": [
"Sink"
],
"summary": "Delete Sink",
"description": "Delete a sink.",
"operationId": "v1.streaming.sink.delete",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"204": {
"description": "no content"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "await svix.streaming.sink.delete(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "await svix.streaming.sink.delete(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "svix.streaming.sink.delete(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "await svix.streaming.sink.delete(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "err := svix.Streaming.Sink.Delete(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "svix.streaming.sink.delete(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Java",
"lang": "Java",
"source": "svix.getStreaming()\n .getSink()\n .delete(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.sink.delete(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "svix.streaming()\n .sink()\n .delete(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Sink.Delete(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$svix->streaming->sink->delete(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming sink delete \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'DELETE' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa' \\\n -H 'Authorization: Bearer AUTH_TOKEN'"
}
]
},
"patch": {
"tags": [
"Sink"
],
"summary": "Patch Sink",
"description": "Partially update a sink.",
"operationId": "v1.streaming.sink.patch",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamSinkPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamSinkOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.sink.patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n uid: \"unique-identifier\",\n status: SinkStatusIn.Enabled,\n batchSize: 100,\n maxWaitSecs: 1,\n eventTypes: [],\n metadata: {},\n type: \"azureBlobStorage\",\n config: {\n container: \"sample string\",\n account: \"sample string\",\n accessKey: \"sample string\",\n },\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.sink.patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n uid: \"unique-identifier\",\n status: SinkStatusIn.Enabled,\n batchSize: 100,\n maxWaitSecs: 1,\n eventTypes: [],\n metadata: {},\n type: \"azureBlobStorage\",\n config: {\n container: \"sample string\",\n account: \"sample string\",\n accessKey: \"sample string\",\n },\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.sink.patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n StreamSinkPatch(\n uid=\"unique-identifier\",\n status=SinkStatusIn.ENABLED,\n batch_size=100,\n max_wait_secs=1,\n event_types=[],\n metadata={},\n type=\"azureBlobStorage\",\n config=AzureBlobStoragePatchConfig(\n container=\"sample string\",\n account=\"sample string\",\n access_key=\"sample string\",\n ),\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.sink.patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n StreamSinkPatch(\n uid=\"unique-identifier\",\n status=SinkStatusIn.ENABLED,\n batch_size=100,\n max_wait_secs=1,\n event_types=[],\n metadata={},\n type=\"azureBlobStorage\",\n config=AzureBlobStoragePatchConfig(\n container=\"sample string\",\n account=\"sample string\",\n access_key=\"sample string\",\n ),\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Sink.Patch(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n\tStreamSinkPatch{\n\t\tUid: NewNullable(\"unique-identifier\"),\n\t\tStatus: NewNullable(SINKSTATUSIN_ENABLED),\n\t\tBatchSize: NewNullable(uint16(100)),\n\t\tMaxWaitSecs: NewNullable(uint16(1)),\n\t\tEventTypes: []string{},\n\t\tMetadata: nil,\n\t\tConfig: (AzureBlobStoragePatchConfig{Container: ptr(\"sample string\"), Account: ptr(\"sample string\"), AccessKey: ptr(\"sample string\")}),\n\t\tType: \"azureBlobStorage\",\n\t},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.sink.patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n StreamSinkPatch(\n uid = MaybeUnset.Present(\"unique-identifier\"),\n status = MaybeUnset.Present(SinkStatusIn.ENABLED),\n batchSize = MaybeUnset.Present(100u),\n maxWaitSecs = MaybeUnset.Present(1u),\n eventTypes = listOf(),\n metadata = mapOf(),\n config =\n StreamSinkPatchConfig.AzureBlobStorage(\n AzureBlobStoragePatchConfig(\n container = \"sample string\",\n account = \"sample string\",\n accessKey = \"sample string\",\n )\n ),\n ),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getSink()\n .patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n new StreamSinkPatch()\n .uid(\"unique-identifier\")\n .status(SinkStatusIn.ENABLED)\n .batchSize(100L)\n .maxWaitSecs(1L)\n .eventTypes(List.of())\n .metadata(Map.of())\n .config(new StreamSinkPatchConfig.AzureBlobStorage(new AzureBlobStoragePatchConfig()\n .container(\"sample string\")\n .account(\"sample string\")\n .accessKey(\"sample string\"))));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .streaming\n .sink\n .patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n uid: \"unique-identifier\",\n status: SinkStatusIn::ENABLED,\n batchSize: 100,\n maxWaitSecs: 1,\n eventTypes: [],\n metadata: {},\n config: {container: \"sample string\", account: \"sample string\", accessKey: \"sample string\"},\n type: \"azureBlobStorage\"\n }\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .sink()\n .patch(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n StreamSinkPatch {\n uid: js_option::JsOption::Some(\"unique-identifier\".to_string()),\n status: js_option::JsOption::Some(SinkStatusIn::Enabled),\n batch_size: js_option::JsOption::Some(100),\n max_wait_secs: js_option::JsOption::Some(1),\n event_types: Some(vec![]),\n metadata: Some(HashMap::new()),\n config: StreamSinkPatchConfig::AzureBlobStorage(AzureBlobStoragePatchConfig {\n container: Some(\"sample string\".to_string()),\n account: Some(\"sample string\".to_string()),\n access_key: Some(\"sample string\".to_string()),\n }),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Sink.Patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n new StreamSinkPatch\n {\n Uid = \"unique-identifier\",\n Status = SinkStatusIn.Enabled,\n BatchSize = 100,\n MaxWaitSecs = 1,\n EventTypes = [],\n Metadata = [],\n Config = StreamSinkPatchConfig.AzureBlobStorage(\n (\n new AzureBlobStoragePatchConfig\n {\n Container = \"sample string\",\n Account = \"sample string\",\n AccessKey = \"sample string\",\n }\n )\n ),\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->sink->patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n StreamSinkPatch::create()\n ->withUid(\"unique-identifier\")\n ->withStatus(SinkStatusIn::ENABLED)\n ->withBatchSize(100)\n ->withMaxWaitSecs(1)\n ->withEventTypes([])\n ->withMetadata([])\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming sink patch \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\" '{\n \"batchSize\": 100,\n \"config\": {\n \"accessKey\": \"sample string\",\n \"account\": \"sample string\",\n \"container\": \"sample string\"\n },\n \"eventTypes\": [],\n \"maxWaitSecs\": 1,\n \"metadata\": {},\n \"status\": \"enabled\",\n \"type\": \"azureBlobStorage\",\n \"uid\": \"unique-identifier\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PATCH' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"batchSize\": 100,\n \"config\": {\n \"accessKey\": \"sample string\",\n \"account\": \"sample string\",\n \"container\": \"sample string\"\n },\n \"eventTypes\": [],\n \"maxWaitSecs\": 1,\n \"metadata\": {},\n \"status\": \"enabled\",\n \"type\": \"azureBlobStorage\",\n \"uid\": \"unique-identifier\"\n }'"
}
]
}
},
"/api/v1/stream/{stream_id}/sink/{sink_id}/events": {
"get": {
"tags": [
"Event"
],
"summary": "Poller Sink Stream Events",
"description": "Iterate over a stream of events.\n\nThe sink must be of type `poller` to use the poller endpoint.",
"operationId": "v1.streaming.events.get",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"nullable": true
},
"style": "form"
},
{
"in": "query",
"name": "after",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventStreamOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.events.get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.events.get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.events.get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.events.get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Events.Get(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.streaming.events.get(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getEvents()\n .get(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.events.get(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .events()\n .get(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Events.Get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->events->get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming events get \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa/events' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/stream/{stream_id}/sink/{sink_id}/headers": {
"get": {
"tags": [
"Sink"
],
"summary": "Get Sink Headers",
"description": "Get the HTTP sink headers. Only valid for `http` or `otelTracing` sinks.",
"operationId": "v1.streaming.sink-headers-get",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "The value of the headers is returned in the `headers` field.\n\nSensitive headers that have been redacted are returned in the sensitive field.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointHeadersOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.sinkHeadersGet(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.sinkHeadersGet(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.sink_headers_get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.sink_headers_get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.SinkHeadersGet(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.sinkHeadersGet(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .sinkHeadersGet(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.sink_headers_get(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .sink_headers_get(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.SinkHeadersGet(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->sinkHeadersGet(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming sink-headers-get \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa/headers' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"patch": {
"tags": [
"Sink"
],
"summary": "Patch Sink Headers",
"description": "Updates the Sink's headers. Only valid for `http` or `otelTracing` sinks.",
"operationId": "v1.streaming.sink-headers-patch",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpSinkHeadersPatchIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "The value of the headers is returned in the `headers` field.\n\nSensitive headers that have been redacted are returned in the sensitive field.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointHeadersOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.sinkHeadersPatch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n headers: { \"X-Example\": \"123\", \"X-Foobar\": \"Bar\" },\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.sinkHeadersPatch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n headers: { \"X-Example\": \"123\", \"X-Foobar\": \"Bar\" },\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.sink_headers_patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n HttpSinkHeadersPatchIn(\n headers={\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.sink_headers_patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n HttpSinkHeadersPatchIn(\n headers={\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.SinkHeadersPatch(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n\tHttpSinkHeadersPatchIn{Headers: map[string]string{\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"}},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.sinkHeadersPatch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n HttpSinkHeadersPatchIn(headers = mapOf(\"X-Example\" to \"123\", \"X-Foobar\" to \"Bar\")),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .sinkHeadersPatch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n new HttpSinkHeadersPatchIn()\n .headers(\n Map.ofEntries(Map.entry(\"X-Example\", \"123\"), Map.entry(\"X-Foobar\", \"Bar\"))));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .streaming\n .sink_headers_patch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {headers: {:\"X-Example\" => \"123\", :\"X-Foobar\" => \"Bar\"}}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .sink_headers_patch(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n HttpSinkHeadersPatchIn {\n headers: HashMap::from([\n (\"X-Example\".to_string(), \"123\".to_string()),\n (\"X-Foobar\".to_string(), \"Bar\".to_string()),\n ]),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.SinkHeadersPatch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n new HttpSinkHeadersPatchIn\n {\n Headers = new() { { \"X-Example\", \"123\" }, { \"X-Foobar\", \"Bar\" } },\n }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->sinkHeadersPatch(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n HttpSinkHeadersPatchIn::create(\n headers: [\"X-Example\" => \"123\", \"X-Foobar\" => \"Bar\"]\n )\n\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming sink-headers-patch \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\" '{\n \"headers\": {\n \"X-Example\": \"123\",\n \"X-Foobar\": \"Bar\"\n }\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PATCH' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa/headers' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"headers\": {\n \"X-Example\": \"123\",\n \"X-Foobar\": \"Bar\"\n }\n }'"
}
]
}
},
"/api/v1/stream/{stream_id}/sink/{sink_id}/secret": {
"get": {
"tags": [
"Sink"
],
"summary": "Get Sink Secret",
"description": "Get the sink's signing secret (only supported for http sinks)\n\nThis is used to verify the authenticity of the delivery.\n\nFor more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).",
"operationId": "v1.streaming.sink.get-secret",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SinkSecretOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.sink.getSecret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.sink.getSecret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.sink.get_secret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.sink.get_secret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Sink.GetSecret(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.sink.getSecret(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getSink()\n .getSecret(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.sink.get_secret(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .sink()\n .get_secret(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Sink.GetSecret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->sink->getSecret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming sink get-secret \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa/secret' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
}
},
"/api/v1/stream/{stream_id}/sink/{sink_id}/secret/rotate": {
"post": {
"tags": [
"Sink"
],
"summary": "Rotate Sink Secret",
"description": "Rotates the signing secret (only supported for http sinks).",
"operationId": "v1.streaming.sink.rotate-secret",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndpointSecretRotateIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.sink.rotateSecret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n key: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.sink.rotateSecret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n key: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.sink.rotate_secret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n EndpointSecretRotateIn(\n key=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.sink.rotate_secret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n EndpointSecretRotateIn(\n key=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Sink.RotateSecret(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n\tEndpointSecretRotateIn{Key: ptr(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")},\n\tnil,\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.sink.rotateSecret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n EndpointSecretRotateIn(key = \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getSink()\n .rotateSecret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n new EndpointSecretRotateIn().key(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .streaming\n .sink\n .rotate_secret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {key: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"}\n )"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .sink()\n .rotate_secret(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n EndpointSecretRotateIn {\n key: Some(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\".to_string()),\n },\n None,\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Sink.RotateSecret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n new EndpointSecretRotateIn { Key = \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\" }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->sink->rotateSecret(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n EndpointSecretRotateIn::create()\n ->withKey(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming sink rotate-secret \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\" '{\n \"key\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'POST' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa/secret/rotate' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"key\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n }'"
}
]
}
},
"/api/v1/stream/{stream_id}/sink/{sink_id}/transformation": {
"get": {
"tags": [
"Sink"
],
"summary": "Get Sink Transformation",
"description": "Get the transformation code associated with this sink.",
"operationId": "v1.streaming.sink-transformation-get",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SinkTransformationOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.sinkTransformationGet(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.sinkTransformationGet(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.sink_transformation_get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.sink_transformation_get(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.SinkTransformationGet(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.sinkTransformationGet(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .sinkTransformationGet(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\");"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.streaming.sink_transformation_get(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\")"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .sink_transformation_get(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.SinkTransformationGet(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->sinkTransformationGet(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\"\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming sink-transformation-get \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\""
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa/transformation' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"patch": {
"tags": [
"Sink"
],
"summary": "Set Sink Transformation",
"description": "Set or unset the transformation code associated with this sink.",
"operationId": "v1.streaming.sink.transformation-partial-update",
"parameters": [
{
"in": "path",
"name": "stream_id",
"description": "The Stream's ID or UID.",
"required": true,
"schema": {
"description": "The Stream's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
},
{
"in": "path",
"name": "sink_id",
"description": "The StreamSink's ID or UID.",
"required": true,
"schema": {
"description": "The StreamSink's ID or UID.",
"type": "string",
"maxLength": 60,
"minLength": 1,
"example": "unique-identifier"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SinkTransformIn"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.streaming.sink.transformationPartialUpdate(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n code: \"sample string\",\n }\n);"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.streaming.sink.transformationPartialUpdate(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n {\n code: \"sample string\",\n }\n);"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.streaming.sink.transformation_partial_update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n SinkTransformIn(\n code=\"sample string\",\n ),\n)"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.streaming.sink.transformation_partial_update(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n SinkTransformIn(\n code=\"sample string\",\n ),\n)"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Streaming.Sink.TransformationPartialUpdate(\n\tctx,\n\t\"strm_31Dc0DD72P5AddYUguyBd\",\n\t\"sink_31Dc11sPYY9aLDkwPuGMa\",\n\tSinkTransformIn{Code: ptr(\"sample string\")},\n)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response =\n svix.streaming.sink.transformationPartialUpdate(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n SinkTransformIn(code = \"sample string\"),\n )"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getStreaming()\n .getSink()\n .transformationPartialUpdate(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n new SinkTransformIn().code(\"sample string\"));"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix\n .streaming\n .sink\n .transformation_partial_update(\"strm_31Dc0DD72P5AddYUguyBd\", \"sink_31Dc11sPYY9aLDkwPuGMa\", {code: \"sample string\"})"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix\n .streaming()\n .sink()\n .transformation_partial_update(\n \"strm_31Dc0DD72P5AddYUguyBd\".to_string(),\n \"sink_31Dc11sPYY9aLDkwPuGMa\".to_string(),\n SinkTransformIn {\n code: Some(\"sample string\".to_string()),\n },\n )\n .await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Streaming.Sink.TransformationPartialUpdate(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n new SinkTransformIn { Code = \"sample string\" }\n);"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->streaming->sink->transformationPartialUpdate(\n \"strm_31Dc0DD72P5AddYUguyBd\",\n \"sink_31Dc11sPYY9aLDkwPuGMa\",\n SinkTransformIn::create()\n ->withCode(\"sample string\")\n);"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix streaming sink transformation-partial-update \"strm_31Dc0DD72P5AddYUguyBd\" \"sink_31Dc11sPYY9aLDkwPuGMa\" '{\n \"code\": \"sample string\"\n }'"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'PATCH' \\\n 'https://api.eu.svix.com/api/v1/stream/strm_31Dc0DD72P5AddYUguyBd/sink/sink_31Dc11sPYY9aLDkwPuGMa/transformation' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"code\": \"sample string\"\n }'"
}
]
}
},
"/ingest/api/v1/source": {
"get": {
"tags": [
"Ingest Source"
],
"summary": "List Ingest Sources",
"description": "List of all the organization's Ingest Sources.",
"operationId": "v1.ingest.source.list",
"parameters": [
{
"in": "query",
"name": "limit",
"description": "Limit the number of returned items",
"schema": {
"description": "Limit the number of returned items",
"type": "integer",
"format": "uint64",
"maximum": 250,
"minimum": 1
},
"style": "form"
},
{
"in": "query",
"name": "iterator",
"description": "The iterator returned from a prior invocation",
"schema": {
"description": "The iterator returned from a prior invocation",
"type": "string",
"maxLength": 26,
"minLength": 26,
"pattern": "^src_[A-Za-z0-9]{22}$",
"nullable": true,
"example": "src_2yZwUhtgs5Ai8T9yRQJXA"
},
"style": "form"
},
{
"in": "query",
"name": "order",
"description": "The sorting order of the returned items",
"schema": {
"description": "The sorting order of the returned items",
"$ref": "#/components/schemas/Ordering",
"nullable": true
},
"style": "form"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListResponse_IngestSourceOut_"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
],
"x-codeSamples": [
{
"label": "JavaScript",
"lang": "JavaScript",
"source": "const response = await svix.ingest.source.list();"
},
{
"label": "TypeScript",
"lang": "TypeScript",
"source": "const response = await svix.ingest.source.list();"
},
{
"label": "Python",
"lang": "Python",
"source": "response = svix.ingest.source.list()"
},
{
"label": "Python (Async)",
"lang": "Python (Async)",
"source": "response = await svix.ingest.source.list()"
},
{
"label": "Go",
"lang": "Go",
"source": "response, err := svix.Ingest.Source.List(ctx, nil)"
},
{
"label": "Kotlin",
"lang": "Kotlin",
"source": "val response = svix.ingest.source.list()"
},
{
"label": "Java",
"lang": "Java",
"source": "var response = svix.getIngest().getSource().list();"
},
{
"label": "Ruby",
"lang": "Ruby",
"source": "response = svix.ingest.source.list"
},
{
"label": "Rust",
"lang": "Rust",
"source": "let response = svix.ingest().source().list(None).await?;"
},
{
"label": "C#",
"lang": "C#",
"source": "var response = svix.Ingest.Source.List();"
},
{
"label": "PHP",
"lang": "PHP",
"source": "$response = $svix->ingest->source->list();"
},
{
"label": "CLI",
"lang": "CLI",
"source": "svix ingest source list"
},
{
"label": "cURL",
"lang": "cURL",
"source": "curl -X 'GET' \\\n 'https://api.eu.svix.com/ingest/api/v1/source' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'Accept: application/json'"
}
]
},
"post": {
"tags": [
"Ingest Source"
],
"summary": "Create Ingest Source",
"description": "Create Ingest Source.",
"operationId": "v1.ingest.source.create",
"parameters": [
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "idempotency-key",
"description": "The request's idempotency key",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngestSourceIn"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngestSourceOut"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorOut"
}
}
}
},
"404": {
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment