openapi: 3.1.0
info:
title: Svix Application Endpoint API
description: 'Welcome to the Svix API documentation!
Useful 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/)
# Introduction
This 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).
## Main concepts
In Svix you have four important entities you will be interacting with:
- `messages`: these are the webhooks being sent. They can have contents and a few other properties.
- `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform.
- `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).
- `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.
## Authentication
Get 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).
<SecurityDefinitions />
## Code samples
The 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/).
## Idempotency
Svix 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.
To 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.
Svix''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.
Please note that idempotency is only supported for `POST` requests.
## Cross-Origin Resource Sharing
This 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.
'
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
tags:
- name: Endpoint
description: Endpoints are the URLs messages will be sent to. Each application can have up to 50 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).
paths:
/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.0
minimum: 1.0
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: TypeScript
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
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: Shell
source: svix endpoint list "app_1srOrx2ZWZBpBUvZwXKQmoEYga2"
- label: cURL
lang: Shell
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.
When `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: TypeScript
source: "const response = await svix.endpoint.create(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n channels: [\"project_123\", \"group_2\"],\n description: \"An example endpoint name\",\n disabled: true,\n filterTypes: [\"user.signup\", \"user.deleted\"],\n headers: { \"X-Example\": \"123\", \"X-Foobar\": \"Bar\" },\n metadata: {},\n secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n});"
- label: TypeScript
lang: TypeScript
source: "const response = await svix.endpoint.create(\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\", {\n channels: [\"project_123\", \"group_2\"],\n description: \"An example endpoint name\",\n disabled: true,\n filterTypes: [\"user.signup\", \"user.deleted\"],\n headers: { \"X-Example\": \"123\", \"X-Foobar\": \"Bar\" },\n metadata: {},\n secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n});"
- label: Python
lang: Python
source: "response = svix.endpoint.create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n EndpointIn(\n channels=[\n \"project_123\",\n \"group_2\",\n ],\n description=\"An example endpoint name\",\n disabled=True,\n filter_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n headers={\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n metadata={},\n secret=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n throttle_rate=1,\n uid=\"unique-identifier\",\n url=\"https://example.com/webhook/\",\n ),\n)"
- label: Python (Async)
lang: Python
source: "response = await svix.endpoint.create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n EndpointIn(\n channels=[\n \"project_123\",\n \"group_2\",\n ],\n description=\"An example endpoint name\",\n disabled=True,\n filter_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n headers={\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n metadata={},\n secret=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n throttle_rate=1,\n uid=\"unique-identifier\",\n url=\"https://example.com/webhook/\",\n ),\n)"
- label: Go
lang: Go
source: "response, err := svix.Endpoint.Create(\n\tctx,\n\t\"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n\tEndpointIn{\n\t\tChannels: []string{\"project_123\", \"group_2\"},\n\t\tDescription: new(\"An example endpoint name\"),\n\t\tDisabled: new(true),\n\t\tFilterTypes: []string{\"user.signup\", \"user.deleted\"},\n\t\tHeaders: &map[string]string{\"X-Example\": \"123\", \"X-Foobar\": \"Bar\"},\n\t\tMetadata: nil,\n\t\tSecret: new(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"),\n\t\tThrottleRate: new(uint16(1)),\n\t\tUid: new(\"unique-identifier\"),\n\t\tUrl: \"https://example.com/webhook/\",\n\t},\n\tnil,\n)"
- label: Kotlin
lang: Kotlin
source: "val response =\n svix.endpoint.create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n EndpointIn(\n channels = setOf(\"project_123\", \"group_2\"),\n description = \"An example endpoint name\",\n disabled = true,\n filterTypes = setOf(\"user.signup\", \"user.deleted\"),\n headers = mapOf(\"X-Example\" to \"123\", \"X-Foobar\" to \"Bar\"),\n metadata = mapOf(),\n secret = \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n throttleRate = 1u,\n uid = \"unique-identifier\",\n url = \"https://example.com/webhook/\",\n ),\n )"
- label: Java
lang: Java
source: "var response = svix.getEndpoint()\n .create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new EndpointIn()\n .channels(Set.of(\"project_123\", \"group_2\"))\n .description(\"An example endpoint name\")\n .disabled(true)\n .filterTypes(Set.of(\"user.signup\", \"user.deleted\"))\n .headers(Map.ofEntries(Map.entry(\"X-Example\", \"123\"), Map.entry(\"X-Foobar\", \"Bar\")))\n .metadata(Map.of())\n .secret(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")\n .throttleRate(1L)\n .uid(\"unique-identifier\")\n .url(URI.create(\"https://example.com/webhook/\")));"
- label: Ruby
lang: Ruby
source: "response = svix\n .endpoint\n .create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n {\n channels: [\"project_123\", \"group_2\"],\n description: \"An example endpoint name\",\n disabled: true,\n filterTypes: [\"user.signup\", \"user.deleted\"],\n headers: {:\"X-Example\" => \"123\", :\"X-Foobar\" => \"Bar\"},\n metadata: {},\n secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\"\n }\n )"
- label: Rust
lang: Rust
source: "let response = svix\n .endpoint()\n .create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\".to_string(),\n EndpointIn {\n channels: Some(vec![\"project_123\".to_string(), \"group_2\".to_string()]),\n description: Some(\"An example endpoint name\".to_string()),\n disabled: Some(true),\n filter_types: Some(\n vec![\"user.signup\".to_string(), \"user.deleted\".to_string()],\n ),\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 metadata: Some(HashMap::new()),\n secret: Some(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\".to_string()),\n throttle_rate: Some(1),\n uid: Some(\"unique-identifier\".to_string()),\n url: \"https://example.com/webhook/\".to_string(),\n },\n None,\n )\n .await?;"
- label: C#
lang: C#
source: "var response = svix.Endpoint.Create(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n new EndpointIn\n {\n Channels = [\"project_123\", \"group_2\"],\n Description = \"An example endpoint name\",\n Disabled = true,\n FilterTypes = [\"user.signup\", \"user.deleted\"],\n Headers = new() { { \"X-Example\", \"123\" }, { \"X-Foobar\", \"Bar\" } },\n Metadata = [],\n Secret = \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n ThrottleRate = 1,\n Uid = \"unique-identifier\",\n Url = \"https://example.com/webhook/\",\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 ->withChannels([\"project_123\",\"group_2\"])\n ->withDescription(\"An example endpoint name\")\n ->withDisabled(true)\n ->withFilterTypes([\"user.signup\",\"user.deleted\"])\n ->withHeaders([\"X-Example\" => \"123\", \"X-Foobar\" => \"Bar\"])\n ->withMetadata([])\n ->withSecret(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")\n ->withThrottleRate(1)\n ->withUid(\"unique-identifier\")\n);"
- label: CLI
lang: Shell
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 \"secret\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\",\n \"throttleRate\": 1,\n \"uid\": \"unique-identifier\",\n \"url\": \"https://example.com/webhook/\"\n }'"
- label: cURL
lang: Shell
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 \"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: TypeScript
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
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: Shell
source: svix endpoint get "app_1srOrx2ZWZBpBUvZwXKQmoEYga2" "ep_33ZIBDmz66FcPG35FnsbM6Ie4X1"
- label: cURL
lang: Shell
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: TypeScript
source: "const response = await svix.endpoint.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n channels: [\"project_123\", \"group_2\"],\n description: \"An example endpoint name\",\n disabled: true,\n filterTypes: [\"user.signup\", \"user.deleted\"],\n metadata: {},\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n }\n);"
- label: TypeScript
lang: TypeScript
source: "const response = await svix.endpoint.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n channels: [\"project_123\", \"group_2\"],\n description: \"An example endpoint name\",\n disabled: true,\n filterTypes: [\"user.signup\", \"user.deleted\"],\n metadata: {},\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\",\n }\n);"
- label: Python
lang: Python
source: "response = svix.endpoint.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointUpdate(\n channels=[\n \"project_123\",\n \"group_2\",\n ],\n description=\"An example endpoint name\",\n disabled=True,\n filter_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n metadata={},\n throttle_rate=1,\n uid=\"unique-identifier\",\n url=\"https://example.com/webhook/\",\n ),\n)"
- label: Python (Async)
lang: Python
source: "response = await svix.endpoint.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointUpdate(\n channels=[\n \"project_123\",\n \"group_2\",\n ],\n description=\"An example endpoint name\",\n disabled=True,\n filter_types=[\n \"user.signup\",\n \"user.deleted\",\n ],\n metadata={},\n throttle_rate=1,\n uid=\"unique-identifier\",\n url=\"https://example.com/webhook/\",\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\tChannels: []string{\"project_123\", \"group_2\"},\n\t\tDescription: new(\"An example endpoint name\"),\n\t\tDisabled: new(true),\n\t\tFilterTypes: []string{\"user.signup\", \"user.deleted\"},\n\t\tMetadata: nil,\n\t\tThrottleRate: new(uint16(1)),\n\t\tUid: new(\"unique-identifier\"),\n\t\tUrl: \"https://example.com/webhook/\",\n\t},\n)"
- label: Kotlin
lang: Kotlin
source: "val response =\n svix.endpoint.update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n EndpointUpdate(\n channels = setOf(\"project_123\", \"group_2\"),\n description = \"An example endpoint name\",\n disabled = true,\n filterTypes = setOf(\"user.signup\", \"user.deleted\"),\n metadata = mapOf(),\n throttleRate = 1u,\n uid = \"unique-identifier\",\n url = \"https://example.com/webhook/\",\n ),\n )"
- label: Java
lang: Java
source: "var response = svix.getEndpoint()\n .update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n new EndpointUpdate()\n .channels(Set.of(\"project_123\", \"group_2\"))\n .description(\"An example endpoint name\")\n .disabled(true)\n .filterTypes(Set.of(\"user.signup\", \"user.deleted\"))\n .metadata(Map.of())\n .throttleRate(1L)\n .uid(\"unique-identifier\")\n .url(URI.create(\"https://example.com/webhook/\")));"
- label: Ruby
lang: Ruby
source: "response = svix\n .endpoint\n .update(\n \"app_1srOrx2ZWZBpBUvZwXKQmoEYga2\",\n \"ep_33ZIBDmz66FcPG35FnsbM6Ie4X1\",\n {\n channels: [\"project_123\", \"group_2\"],\n description: \"An example endpoint name\",\n disabled: true,\n filterTypes: [\"user.signup\", \"user.deleted\"],\n metadata: {},\n throttleRate: 1,\n uid: \"unique-identifier\",\n url: \"https://example.com/webhook/\"\n }\n )"
- label: Rust
# --- truncated at 32 KB (161 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/openapi/svix-endpoint-api-openapi.yml