openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 275 kB
JSON
{"openapi":"3.0.2","info":{"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}`.\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.\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.\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","title":"Svix API","version":"1.4","x-logo":{"altText":"Svix Logo","url":"https://www.svix.com/static/img/brand-padded.svg"},"x-origin":[{"format":"openapi","url":"https://api.svix.com/api/v1/openapi.json","version":"3.0"}],"x-providerName":"svix.com"},"tags":[{"description":"Consumer Applications are where messages are sent to. In most cases you would want to have one application for each of your users.","name":"Application"},{"description":"Messages are the webhook events being sent.","name":"Message"},{"description":"Attempts to deliver `Message`s to `Endpoint`s.","name":"Message Attempt"},{"description":"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).","name":"Endpoint"},{"description":"Integrations are services your users connect an application to. An integration can manage the application and it's endpoints.","name":"Integration"},{"description":"Event types are identifiers denoting the type of message being sent. Event types are primarily used to decide which events are sent to which endpoint.","name":"Event Type"},{"description":"Easily give your users access to our pre-built management UI.","name":"Authentication"},{"description":"Health checks for the API.","name":"Health"},{"description":"The webhooks the Svix service sends to notify you of events.","name":"Webhooks"}],"paths":{"/api/v1/app/":{"get":{"description":"List of all the organization's applications.","operationId":"list_applications_api_v1_app__get","parameters":[{"in":"query","name":"iterator","required":false,"schema":{"example":"app_1srOrx2ZWZBpBUvZwXKQmoEYga2","nullable":true,"title":"Iterator","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"default":50,"maximum":250,"title":"Limit","type":"integer"}},{"in":"query","name":"order","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Ordering"}],"default":"descending"}},{"description":"The request's idempotency key","in":"header","name":"idempotency-key","required":false,"schema":{"description":"The request's idempotency key","nullable":true,"title":"Idempotency-Key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_ApplicationOut_"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Conflict"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Too Many Requests"}},"security":[{"HTTPBearer":[]}],"summary":"List Applications","tags":["Application"],"x-codeSamples":[{"label":"JavaScript","lang":"JavaScript","source":"const listResponseApplicationOut = await svix.application.list();"},{"label":"TypeScript","lang":"JavaScript","source":"const listResponseApplicationOut = await svix.application.list();"},{"label":"Python","lang":"Python","source":"list_response_application_out = svix.application.list()"},{"label":"Python (Async)","lang":"Python","source":"list_response_application_out = await svix.application.list()"},{"label":"Go","lang":"Go","source":"listResponseApplicationOut, err := svixClient.Application.List(nil)"},{"label":"Kotlin","lang":"Kotlin","source":"val listResponseApplicationOut = svix.application.list(FetchOptions())"},{"label":"Java","lang":"Java","source":"ListResponseApplicationOut listResponseApplicationOut = svix.getApplication().list(new FetchOptions())"},{"label":"Ruby","lang":"Ruby","source":"list_response_application_out = svix.application.list"},{"label":"Rust","lang":"Rust","source":"let list_response_application_out = svix.application().list(None).await?;"},{"label":"C#","lang":"C#","source":"var listResponseApplicationOut = await svix.Application.ListAsync()"},{"label":"CLI","lang":"Shell","source":"svix application list "},{"label":"cURL","lang":"Shell","source":"curl -X 'GET' \\\n 'https://api.svix.com/api/v1/app/' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'accept: application/json' \\\n -H 'Content-Type: application/json'"}]},"post":{"description":"Create a new application.","operationId":"create_application_api_v1_app__post","parameters":[{"description":"Get an existing application, or create a new one if doesn't exist. It's two separate functions in the libs.","in":"query","name":"get_if_exists","required":false,"schema":{"default":false,"description":"Get an existing application, or create a new one if doesn't exist. It's two separate functions in the libs.","title":"Get If Exists","type":"boolean"}},{"description":"The request's idempotency key","in":"header","name":"idempotency-key","required":false,"schema":{"description":"The request's idempotency key","nullable":true,"title":"Idempotency-Key","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationIn"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationOut"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationOut"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Conflict"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Too Many Requests"}},"security":[{"HTTPBearer":[]}],"summary":"Create Application","tags":["Application"],"x-codeSamples":[{"label":"JavaScript","lang":"JavaScript","source":"const applicationOut = await svix.application.create({\n uid: \"unique-app-identifier\",\n name: \"My first application\",\n rateLimit: 1000,\n metadata: None\n})\n// Or \nconst applicationOut = await svix.application.getOrCreate({\n uid: \"unique-app-identifier\",\n name: \"My first application\",\n rateLimit: 1000,\n metadata: None\n})"},{"label":"TypeScript","lang":"JavaScript","source":"const applicationOut = await svix.application.create({\n uid: \"unique-app-identifier\",\n name: \"My first application\",\n rateLimit: 1000,\n metadata: None\n})\n// Or \nconst applicationOut = await svix.application.getOrCreate({\n uid: \"unique-app-identifier\",\n name: \"My first application\",\n rateLimit: 1000,\n metadata: None\n})"},{"label":"Python","lang":"Python","source":"application_out = svix.application.create(ApplicationIn(\n uid=\"unique-app-identifier\",\n name=\"My first application\",\n rate_limit=1000,\n metadata=None\n))\n# Or \napplication_out = svix.application.get_or_create(ApplicationIn(\n uid=\"unique-app-identifier\",\n name=\"My first application\",\n rate_limit=1000,\n metadata=None\n))"},{"label":"Python (Async)","lang":"Python","source":"application_out = await svix.application.create(ApplicationIn(\n uid=\"unique-app-identifier\",\n name=\"My first application\",\n rate_limit=1000,\n metadata=None\n))\n# Or \napplication_out = await svix.application.get_or_create(ApplicationIn(\n uid=\"unique-app-identifier\",\n name=\"My first application\",\n rate_limit=1000,\n metadata=None\n))"},{"label":"Go","lang":"Go","source":"applicationOut, err := svixClient.Application.Create(&svix.ApplicationIn{\n Uid: \"unique-app-identifier\",\n Name: \"My first application\",\n RateLimit: 1000,\n Metadata: None\n})\n// Or \napplicationOut, err := svixClient.Application.GetOrCreate(&svix.ApplicationIn{\n Uid: \"unique-app-identifier\",\n Name: \"My first application\",\n RateLimit: 1000,\n Metadata: None\n})"},{"label":"Kotlin","lang":"Kotlin","source":"val applicationOut = svix.application.create(ApplicationIn()\n .uid(\"unique-app-identifier\"),\n .name(\"My first application\"),\n .rateLimit(1000),\n .metadata(None)\n)\n// Or \nval applicationOut = svix.application.getOrCreate(ApplicationIn()\n .uid(\"unique-app-identifier\"),\n .name(\"My first application\"),\n .rateLimit(1000),\n .metadata(None)\n)"},{"label":"Java","lang":"Java","source":"ApplicationOut applicationOut = svix.getApplication().create(new ApplicationIn()\n .uid(\"unique-app-identifier\"),\n .name(\"My first application\"),\n .rateLimit(1000),\n .metadata(None)\n)\n// Or \nApplicationOut applicationOut = svix.getApplication().getOrCreate(new ApplicationIn()\n .uid(\"unique-app-identifier\"),\n .name(\"My first application\"),\n .rateLimit(1000),\n .metadata(None)\n)"},{"label":"Ruby","lang":"Ruby","source":"application_out = svix.application.create(Svix::ApplicationIn.new({\n \"uid\": \"unique-app-identifier\",\n \"name\": \"My first application\",\n \"rate_limit\": 1000,\n \"metadata\": null\n}))\n# Or \napplication_out = svix.application.get_or_create(Svix::ApplicationIn.new({\n \"uid\": \"unique-app-identifier\",\n \"name\": \"My first application\",\n \"rate_limit\": 1000,\n \"metadata\": null\n}))"},{"label":"Rust","lang":"Rust","source":"let application_out = svix.application().create(ApplicationIn {\n uid: Some(\"unique-app-identifier\".to_string()),\n name: \"My first application\".to_string(),\n rate_limit: Some(1000),\n metadata: None\n}, None).await?;\n// Or \nlet application_out = svix.application().get_or_create(ApplicationIn {\n uid: Some(\"unique-app-identifier\".to_string()),\n name: \"My first application\".to_string(),\n rate_limit: Some(1000),\n metadata: None\n}, None).await?;"},{"label":"C#","lang":"C#","source":"var applicationOut = await svix.Application.CreateAsync(new ApplicationIn{\n uid: \"unique-app-identifier\",\n name: \"My first application\",\n rateLimit: 1000,\n metadata: None\n})"},{"label":"CLI","lang":"Shell","source":"svix application create '{\n \"uid\": \"unique-app-identifier\",\n \"name\": \"My first application\",\n \"rateLimit\": 1000,\n \"metadata\": null\n}'"},{"label":"cURL","lang":"Shell","source":"curl -X 'POST' \\\n 'https://api.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 \"uid\": \"unique-app-identifier\",\n \"name\": \"My first application\",\n \"rateLimit\": 1000,\n \"metadata\": null\n}'"}]}},"/api/v1/app/{app_id}/":{"delete":{"description":"Delete an application.","operationId":"delete_application_api_v1_app__app_id___delete","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"description":"The application's ID or UID","example":"app_1srOrx2ZWZBpBUvZwXKQmoEYga2","maxLength":256,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"App Id","type":"string"}},{"description":"The request's idempotency key","in":"header","name":"idempotency-key","required":false,"schema":{"description":"The request's idempotency key","nullable":true,"title":"Idempotency-Key","type":"string"}}],"responses":{"204":{"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Conflict"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Too Many Requests"}},"security":[{"HTTPBearer":[]}],"summary":"Delete Application","tags":["Application"],"x-codeSamples":[{"label":"JavaScript","lang":"JavaScript","source":"await svix.application.delete('app_id');"},{"label":"TypeScript","lang":"JavaScript","source":"await svix.application.delete('app_id');"},{"label":"Python","lang":"Python","source":"svix.application.delete('app_id')"},{"label":"Python (Async)","lang":"Python","source":"await svix.application.delete('app_id')"},{"label":"Go","lang":"Go","source":"err := svixClient.Application.Delete(\"app_id\")"},{"label":"Kotlin","lang":"Kotlin","source":"svix.application.delete('app_id')"},{"label":"Java","lang":"Java","source":"svix.getApplication().delete('app_id')"},{"label":"Ruby","lang":"Ruby","source":"svix.application.delete('app_id')"},{"label":"Rust","lang":"Rust","source":"svix.application().delete(\"app_id\").await?;"},{"label":"C#","lang":"C#","source":"await svix.Application.DeleteAsync(\"app_id\")"},{"label":"CLI","lang":"Shell","source":"svix application delete 'app_id'"},{"label":"cURL","lang":"Shell","source":"curl -X 'DELETE' \\\n 'https://api.svix.com/api/v1/app/{app_id}/' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'accept: application/json' \\\n -H 'Content-Type: application/json'"}]},"get":{"description":"Get an application.","operationId":"get_application_api_v1_app__app_id___get","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"description":"The application's ID or UID","example":"app_1srOrx2ZWZBpBUvZwXKQmoEYga2","maxLength":256,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"App Id","type":"string"}},{"description":"The request's idempotency key","in":"header","name":"idempotency-key","required":false,"schema":{"description":"The request's idempotency key","nullable":true,"title":"Idempotency-Key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationOut"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Conflict"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Too Many Requests"}},"security":[{"HTTPBearer":[]}],"summary":"Get Application","tags":["Application"],"x-codeSamples":[{"label":"JavaScript","lang":"JavaScript","source":"const applicationOut = await svix.application.get('app_id');"},{"label":"TypeScript","lang":"JavaScript","source":"const applicationOut = await svix.application.get('app_id');"},{"label":"Python","lang":"Python","source":"application_out = svix.application.get('app_id')"},{"label":"Python (Async)","lang":"Python","source":"application_out = await svix.application.get('app_id')"},{"label":"Go","lang":"Go","source":"applicationOut, err := svixClient.Application.Get(\"app_id\")"},{"label":"Kotlin","lang":"Kotlin","source":"val applicationOut = svix.application.get('app_id')"},{"label":"Java","lang":"Java","source":"ApplicationOut applicationOut = svix.getApplication().get('app_id')"},{"label":"Ruby","lang":"Ruby","source":"application_out = svix.application.get('app_id')"},{"label":"Rust","lang":"Rust","source":"let application_out = svix.application().get(\"app_id\").await?;"},{"label":"C#","lang":"C#","source":"var applicationOut = await svix.Application.GetAsync(\"app_id\")"},{"label":"CLI","lang":"Shell","source":"svix application get 'app_id'"},{"label":"cURL","lang":"Shell","source":"curl -X 'GET' \\\n 'https://api.svix.com/api/v1/app/{app_id}/' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'accept: application/json' \\\n -H 'Content-Type: application/json'"}]},"put":{"description":"Update an application.","operationId":"update_application_api_v1_app__app_id___put","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"description":"The application's ID or UID","example":"app_1srOrx2ZWZBpBUvZwXKQmoEYga2","maxLength":256,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"App Id","type":"string"}},{"description":"The request's idempotency key","in":"header","name":"idempotency-key","required":false,"schema":{"description":"The request's idempotency key","nullable":true,"title":"Idempotency-Key","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationIn"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationOut"}}},"description":"Successful Response"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationOut"}}},"description":"Created"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Conflict"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Too Many Requests"}},"security":[{"HTTPBearer":[]}],"summary":"Update Application","tags":["Application"],"x-codeSamples":[{"label":"JavaScript","lang":"JavaScript","source":"const applicationOut = await svix.application.update('app_id', {\n uid: \"unique-app-identifier\",\n name: \"My first application\",\n rateLimit: 1000,\n metadata: None\n});"},{"label":"TypeScript","lang":"JavaScript","source":"const applicationOut = await svix.application.update('app_id', {\n uid: \"unique-app-identifier\",\n name: \"My first application\",\n rateLimit: 1000,\n metadata: None\n});"},{"label":"Python","lang":"Python","source":"application_out = svix.application.update('app_id', ApplicationIn(\n uid=\"unique-app-identifier\",\n name=\"My first application\",\n rate_limit=1000,\n metadata=None\n))"},{"label":"Python (Async)","lang":"Python","source":"application_out = await svix.application.update('app_id', ApplicationIn(\n uid=\"unique-app-identifier\",\n name=\"My first application\",\n rate_limit=1000,\n metadata=None\n))"},{"label":"Go","lang":"Go","source":"applicationOut, err := svixClient.Application.Update(\"app_id\", &svix.ApplicationIn{\n Uid: \"unique-app-identifier\",\n Name: \"My first application\",\n RateLimit: 1000,\n Metadata: None\n})"},{"label":"Kotlin","lang":"Kotlin","source":"val applicationOut = svix.application.update('app_id', ApplicationIn()\n .uid(\"unique-app-identifier\"),\n .name(\"My first application\"),\n .rateLimit(1000),\n .metadata(None)\n)"},{"label":"Java","lang":"Java","source":"ApplicationOut applicationOut = svix.getApplication().update('app_id', new ApplicationIn()\n .uid(\"unique-app-identifier\"),\n .name(\"My first application\"),\n .rateLimit(1000),\n .metadata(None)\n)"},{"label":"Ruby","lang":"Ruby","source":"application_out = svix.application.update('app_id', Svix::ApplicationIn.new({\n \"uid\": \"unique-app-identifier\",\n \"name\": \"My first application\",\n \"rate_limit\": 1000,\n \"metadata\": null\n}))"},{"label":"Rust","lang":"Rust","source":"let application_out = svix.application().update(\"app_id\", ApplicationIn {\n uid: Some(\"unique-app-identifier\".to_string()),\n name: \"My first application\".to_string(),\n rate_limit: Some(1000),\n metadata: None\n}, None).await?;"},{"label":"C#","lang":"C#","source":"var applicationOut = await svix.Application.UpdateAsync(\"app_id\", new ApplicationIn{\n uid: \"unique-app-identifier\",\n name: \"My first application\",\n rateLimit: 1000,\n metadata: None\n})"},{"label":"CLI","lang":"Shell","source":"svix application update 'app_id' '{\n \"uid\": \"unique-app-identifier\",\n \"name\": \"My first application\",\n \"rateLimit\": 1000,\n \"metadata\": null\n}'"},{"label":"cURL","lang":"Shell","source":"curl -X 'PUT' \\\n 'https://api.svix.com/api/v1/app/{app_id}/' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"uid\": \"unique-app-identifier\",\n \"name\": \"My first application\",\n \"rateLimit\": 1000,\n \"metadata\": null\n}'"}]}},"/api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}/":{"get":{"description":"List attempts by endpoint id","operationId":"list_attempts_by_endpoint_api_v1_app__app_id__attempt_endpoint__endpoint_id___get","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"description":"The application's ID or UID","example":"app_1srOrx2ZWZBpBUvZwXKQmoEYga2","maxLength":256,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"App Id","type":"string"}},{"in":"path","name":"endpoint_id","required":true,"schema":{"description":"The endpoint's ID or UID","example":"ep_1srOrx2ZWZBpBUvZwXKQmoEYga2","maxLength":256,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"Endpoint Id","type":"string"}},{"in":"query","name":"iterator","required":false,"schema":{"example":"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2","nullable":true,"title":"Iterator","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"default":50,"maximum":250,"title":"Limit","type":"integer"}},{"in":"query","name":"status","required":false,"schema":{"$ref":"#/components/schemas/MessageStatus","nullable":true}},{"in":"query","name":"status_code_class","required":false,"schema":{"$ref":"#/components/schemas/StatusCodeClass","nullable":true}},{"in":"query","name":"event_types","required":false,"schema":{"items":{"example":"user.signup","maxLength":256,"pattern":"^[a-zA-Z0-9\\-_.]+$","type":"string"},"nullable":true,"title":"Event Types","type":"array"}},{"in":"query","name":"channel","required":false,"schema":{"example":"project_1337","maxLength":128,"nullable":true,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"Channel","type":"string"}},{"in":"query","name":"before","required":false,"schema":{"format":"date-time","nullable":true,"title":"Before","type":"string"}},{"in":"query","name":"after","required":false,"schema":{"format":"date-time","nullable":true,"title":"After","type":"string"}},{"description":"The request's idempotency key","in":"header","name":"idempotency-key","required":false,"schema":{"description":"The request's idempotency key","nullable":true,"title":"Idempotency-Key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_MessageAttemptOut_"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Conflict"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Too Many Requests"}},"security":[{"HTTPBearer":[]}],"summary":"List Attempts By Endpoint","tags":["Message Attempt"],"x-codeSamples":[{"label":"JavaScript","lang":"JavaScript","source":"const listResponseMessageAttemptOut = await svix.messageAttempt.listByEndpoint('app_id', 'endpoint_id');"},{"label":"TypeScript","lang":"JavaScript","source":"const listResponseMessageAttemptOut = await svix.messageAttempt.listByEndpoint('app_id', 'endpoint_id');"},{"label":"Python","lang":"Python","source":"list_response_message_attempt_out = svix.message_attempt.list_by_endpoint('app_id', 'endpoint_id')"},{"label":"Python (Async)","lang":"Python","source":"list_response_message_attempt_out = await svix.message_attempt.list_by_endpoint('app_id', 'endpoint_id')"},{"label":"Go","lang":"Go","source":"listResponseMessageAttemptOut, err := svixClient.MessageAttempt.ListByEndpoint(\"app_id\", \"endpoint_id\")"},{"label":"Kotlin","lang":"Kotlin","source":"val listResponseMessageAttemptOut = svix.messageAttempt.listByEndpoint('app_id', 'endpoint_id')"},{"label":"Java","lang":"Java","source":"ListResponseMessageAttemptOut listResponseMessageAttemptOut = svix.getMessageAttempt().listByEndpoint('app_id', 'endpoint_id')"},{"label":"Ruby","lang":"Ruby","source":"list_response_message_attempt_out = svix.message_attempt.list_by_endpoint('app_id', 'endpoint_id')"},{"label":"Rust","lang":"Rust","source":"let list_response_message_attempt_out = svix.message_attempt().list_by_endpoint(\"app_id\", \"endpoint_id\", None).await?;"},{"label":"C#","lang":"C#","source":"var listResponseMessageAttemptOut = await svix.MessageAttempt.ListByEndpointAsync(\"app_id\", \"endpoint_id\")"},{"label":"CLI","lang":"Shell","source":"svix message-attempt list-by-endpoint 'app_id' 'endpoint_id'"},{"label":"cURL","lang":"Shell","source":"curl -X 'GET' \\\n 'https://api.svix.com/api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}/' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'accept: application/json' \\\n -H 'Content-Type: application/json'"}]}},"/api/v1/app/{app_id}/attempt/msg/{msg_id}/":{"get":{"description":"List attempts by message id","operationId":"list_attempts_by_msg_api_v1_app__app_id__attempt_msg__msg_id___get","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"description":"The application's ID or UID","example":"app_1srOrx2ZWZBpBUvZwXKQmoEYga2","maxLength":256,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"App Id","type":"string"}},{"in":"path","name":"msg_id","required":true,"schema":{"description":"The message's ID or eventID","example":"msg_1srOrx2ZWZBpBUvZwXKQmoEYga2","maxLength":256,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"Msg Id","type":"string"}},{"in":"query","name":"endpoint_id","required":false,"schema":{"description":"The endpoint's ID or UID","example":"ep_1srOrx2ZWZBpBUvZwXKQmoEYga2","maxLength":256,"minLength":1,"nullable":true,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"Endpoint Id","type":"string"}},{"in":"query","name":"iterator","required":false,"schema":{"example":"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2","nullable":true,"title":"Iterator","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"default":50,"maximum":250,"title":"Limit","type":"integer"}},{"in":"query","name":"status","required":false,"schema":{"$ref":"#/components/schemas/MessageStatus","nullable":true}},{"in":"query","name":"status_code_class","required":false,"schema":{"$ref":"#/components/schemas/StatusCodeClass","nullable":true}},{"in":"query","name":"event_types","required":false,"schema":{"items":{"example":"user.signup","maxLength":256,"pattern":"^[a-zA-Z0-9\\-_.]+$","type":"string"},"nullable":true,"title":"Event Types","type":"array"}},{"in":"query","name":"channel","required":false,"schema":{"example":"project_1337","maxLength":128,"nullable":true,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"Channel","type":"string"}},{"in":"query","name":"before","required":false,"schema":{"format":"date-time","nullable":true,"title":"Before","type":"string"}},{"in":"query","name":"after","required":false,"schema":{"format":"date-time","nullable":true,"title":"After","type":"string"}},{"description":"The request's idempotency key","in":"header","name":"idempotency-key","required":false,"schema":{"description":"The request's idempotency key","nullable":true,"title":"Idempotency-Key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_MessageAttemptOut_"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Conflict"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Too Many Requests"}},"security":[{"HTTPBearer":[]}],"summary":"List Attempts By Msg","tags":["Message Attempt"],"x-codeSamples":[{"label":"JavaScript","lang":"JavaScript","source":"const listResponseMessageAttemptOut = await svix.messageAttempt.listByMsg('app_id', 'msg_id');"},{"label":"TypeScript","lang":"JavaScript","source":"const listResponseMessageAttemptOut = await svix.messageAttempt.listByMsg('app_id', 'msg_id');"},{"label":"Python","lang":"Python","source":"list_response_message_attempt_out = svix.message_attempt.list_by_msg('app_id', 'msg_id')"},{"label":"Python (Async)","lang":"Python","source":"list_response_message_attempt_out = await svix.message_attempt.list_by_msg('app_id', 'msg_id')"},{"label":"Go","lang":"Go","source":"listResponseMessageAttemptOut, err := svixClient.MessageAttempt.ListByMsg(\"app_id\", \"msg_id\")"},{"label":"Kotlin","lang":"Kotlin","source":"val listResponseMessageAttemptOut = svix.messageAttempt.listByMsg('app_id', 'msg_id')"},{"label":"Java","lang":"Java","source":"ListResponseMessageAttemptOut listResponseMessageAttemptOut = svix.getMessageAttempt().listByMsg('app_id', 'msg_id')"},{"label":"Ruby","lang":"Ruby","source":"list_response_message_attempt_out = svix.message_attempt.list_by_msg('app_id', 'msg_id')"},{"label":"Rust","lang":"Rust","source":"let list_response_message_attempt_out = svix.message_attempt().list_by_msg(\"app_id\", \"msg_id\", None).await?;"},{"label":"C#","lang":"C#","source":"var listResponseMessageAttemptOut = await svix.MessageAttempt.ListByMsgAsync(\"app_id\", \"msg_id\")"},{"label":"CLI","lang":"Shell","source":"svix message-attempt list-by-msg 'app_id' 'msg_id'"},{"label":"cURL","lang":"Shell","source":"curl -X 'GET' \\\n 'https://api.svix.com/api/v1/app/{app_id}/attempt/msg/{msg_id}/' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'accept: application/json' \\\n -H 'Content-Type: application/json'"}]}},"/api/v1/app/{app_id}/endpoint/":{"get":{"description":"List the application's endpoints.","operationId":"list_endpoints_api_v1_app__app_id__endpoint__get","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"description":"The application's ID or UID","example":"app_1srOrx2ZWZBpBUvZwXKQmoEYga2","maxLength":256,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"App Id","type":"string"}},{"in":"query","name":"iterator","required":false,"schema":{"example":"ep_1srOrx2ZWZBpBUvZwXKQmoEYga2","nullable":true,"title":"Iterator","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"default":50,"maximum":250,"title":"Limit","type":"integer"}},{"in":"query","name":"order","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Ordering"}],"default":"descending"}},{"description":"The request's idempotency key","in":"header","name":"idempotency-key","required":false,"schema":{"description":"The request's idempotency key","nullable":true,"title":"Idempotency-Key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_EndpointOut_"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Conflict"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Too Many Requests"}},"security":[{"HTTPBearer":[]}],"summary":"List Endpoints","tags":["Endpoint"],"x-codeSamples":[{"label":"JavaScript","lang":"JavaScript","source":"const listResponseEndpointOut = await svix.endpoint.list('app_id');"},{"label":"TypeScript","lang":"JavaScript","source":"const listResponseEndpointOut = await svix.endpoint.list('app_id');"},{"label":"Python","lang":"Python","source":"list_response_endpoint_out = svix.endpoint.list('app_id')"},{"label":"Python (Async)","lang":"Python","source":"list_response_endpoint_out = await svix.endpoint.list('app_id')"},{"label":"Go","lang":"Go","source":"listResponseEndpointOut, err := svixClient.Endpoint.List(\"app_id\", nil)"},{"label":"Kotlin","lang":"Kotlin","source":"val listResponseEndpointOut = svix.endpoint.list('app_id', FetchOptions())"},{"label":"Java","lang":"Java","source":"ListResponseEndpointOut listResponseEndpointOut = svix.getEndpoint().list('app_id', new FetchOptions())"},{"label":"Ruby","lang":"Ruby","source":"list_response_endpoint_out = svix.endpoint.list('app_id')"},{"label":"Rust","lang":"Rust","source":"let list_response_endpoint_out = svix.endpoint().list(\"app_id\", None).await?;"},{"label":"C#","lang":"C#","source":"var listResponseEndpointOut = await svix.Endpoint.ListAsync(\"app_id\")"},{"label":"CLI","lang":"Shell","source":"svix endpoint list 'app_id'"},{"label":"cURL","lang":"Shell","source":"curl -X 'GET' \\\n 'https://api.svix.com/api/v1/app/{app_id}/endpoint/' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'accept: application/json' \\\n -H 'Content-Type: application/json'"}]},"post":{"description":"Create a new endpoint for the application.\n\nWhen `secret` is `null` the secret is automatically generated (recommended)","operationId":"create_endpoint_api_v1_app__app_id__endpoint__post","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"description":"The application's ID or UID","example":"app_1srOrx2ZWZBpBUvZwXKQmoEYga2","maxLength":256,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"App Id","type":"string"}},{"description":"The request's idempotency key","in":"header","name":"idempotency-key","required":false,"schema":{"description":"The request's idempotency key","nullable":true,"title":"Idempotency-Key","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndpointIn"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndpointOut"}}},"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Conflict"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Too Many Requests"}},"security":[{"HTTPBearer":[]}],"summary":"Create Endpoint","tags":["Endpoint"],"x-codeSamples":[{"label":"JavaScript","lang":"JavaScript","source":"const endpointOut = await svix.endpoint.create('app_id', {\n uid: \"unique-endpoint-identifier\",\n url: \"https://example.com/webhook/\",\n version: 1,\n description: \"An example endpoint name\",\n filterTypes: [\n \"user.signup\",\n \"user.deleted\"\n ],\n channels: [\n \"project_123\",\n \"group_2\"\n ],\n disabled: false,\n rateLimit: 1000,\n metadata: None,\n secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n});"},{"label":"TypeScript","lang":"JavaScript","source":"const endpointOut = await svix.endpoint.create('app_id', {\n uid: \"unique-endpoint-identifier\",\n url: \"https://example.com/webhook/\",\n version: 1,\n description: \"An example endpoint name\",\n filterTypes: [\n \"user.signup\",\n \"user.deleted\"\n ],\n channels: [\n \"project_123\",\n \"group_2\"\n ],\n disabled: false,\n rateLimit: 1000,\n metadata: None,\n secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n});"},{"label":"Python","lang":"Python","source":"endpoint_out = svix.endpoint.create('app_id', EndpointIn(\n uid=\"unique-endpoint-identifier\",\n url=\"https://example.com/webhook/\",\n version=1,\n description=\"An example endpoint name\",\n filter_types=['user.signup', 'user.deleted'],\n channels=['project_123', 'group_2'],\n disabled=False,\n rate_limit=1000,\n metadata=None,\n secret=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n))"},{"label":"Python (Async)","lang":"Python","source":"endpoint_out = await svix.endpoint.create('app_id', EndpointIn(\n uid=\"unique-endpoint-identifier\",\n url=\"https://example.com/webhook/\",\n version=1,\n description=\"An example endpoint name\",\n filter_types=['user.signup', 'user.deleted'],\n channels=['project_123', 'group_2'],\n disabled=False,\n rate_limit=1000,\n metadata=None,\n secret=\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n))"},{"label":"Go","lang":"Go","source":"endpointOut, err := svixClient.Endpoint.Create(\"app_id\", &svix.EndpointIn{\n Uid: \"unique-endpoint-identifier\",\n Url: \"https://example.com/webhook/\",\n Version: 1,\n Description: \"An example endpoint name\",\n FilterTypes: [...]string{\"user.signup\", \"user.deleted\"},\n Channels: [...]string{\"project_123\", \"group_2\"},\n Disabled: False,\n RateLimit: 1000,\n Metadata: None,\n Secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n})"},{"label":"Kotlin","lang":"Kotlin","source":"val endpointOut = svix.endpoint.create('app_id', EndpointIn()\n .uid(\"unique-endpoint-identifier\"),\n .url(\"https://example.com/webhook/\"),\n .version(1),\n .description(\"An example endpoint name\"),\n .filterTypes(arrayOf(\"user.signup\", \"user.deleted\")),\n .channels(arrayOf(\"project_123\", \"group_2\")),\n .disabled(False),\n .rateLimit(1000),\n .metadata(None),\n .secret(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")\n)"},{"label":"Java","lang":"Java","source":"EndpointOut endpointOut = svix.getEndpoint().create('app_id', new EndpointIn()\n .uid(\"unique-endpoint-identifier\"),\n .url(\"https://example.com/webhook/\"),\n .version(1),\n .description(\"An example endpoint name\"),\n .filterTypes(new String[]{\"user.signup\", \"user.deleted\"}),\n .channels(new String[]{\"project_123\", \"group_2\"}),\n .disabled(False),\n .rateLimit(1000),\n .metadata(None),\n .secret(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\")\n)"},{"label":"Ruby","lang":"Ruby","source":"endpoint_out = svix.endpoint.create('app_id', Svix::EndpointIn.new({\n \"uid\": \"unique-endpoint-identifier\",\n \"url\": \"https://example.com/webhook/\",\n \"version\": 1,\n \"description\": \"An example endpoint name\",\n \"filter_types\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"channels\": [\n \"project_123\",\n \"group_2\"\n ],\n \"disabled\": false,\n \"rate_limit\": 1000,\n \"metadata\": null,\n \"secret\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n}))"},{"label":"Rust","lang":"Rust","source":"let endpoint_out = svix.endpoint().create(\"app_id\", EndpointIn {\n uid: Some(\"unique-endpoint-identifier\".to_string()),\n url: \"https://example.com/webhook/\".to_string(),\n version: 1,\n description: Some(\"An example endpoint name\".to_string()),\n filter_types: Some(vec![\"user.signup\".to_string(), \"user.deleted\".to_string()]),\n channels: Some(vec![\"project_123\".to_string(), \"group_2\".to_string()]),\n disabled: Some(False),\n rate_limit: Some(1000),\n metadata: None,\n secret: Some(\"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\".to_string())\n}, None).await?;"},{"label":"C#","lang":"C#","source":"var endpointOut = await svix.Endpoint.CreateAsync(\"app_id\", new EndpointIn{\n uid: \"unique-endpoint-identifier\",\n url: \"https://example.com/webhook/\",\n version: 1,\n description: \"An example endpoint name\",\n filterTypes: new string[] {\"user.signup\", \"user.deleted\"},\n channels: new string[] {\"project_123\", \"group_2\"},\n disabled: false,\n rateLimit: 1000,\n metadata: None,\n secret: \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n})"},{"label":"CLI","lang":"Shell","source":"svix endpoint create 'app_id' '{\n \"uid\": \"unique-endpoint-identifier\",\n \"url\": \"https://example.com/webhook/\",\n \"version\": 1,\n \"description\": \"An example endpoint name\",\n \"filterTypes\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"channels\": [\n \"project_123\",\n \"group_2\"\n ],\n \"disabled\": false,\n \"rateLimit\": 1000,\n \"metadata\": null,\n \"secret\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n}'"},{"label":"cURL","lang":"Shell","source":"curl -X 'POST' \\\n 'https://api.svix.com/api/v1/app/{app_id}/endpoint/' \\\n -H 'Authorization: Bearer AUTH_TOKEN' \\\n -H 'accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"uid\": \"unique-endpoint-identifier\",\n \"url\": \"https://example.com/webhook/\",\n \"version\": 1,\n \"description\": \"An example endpoint name\",\n \"filterTypes\": [\n \"user.signup\",\n \"user.deleted\"\n ],\n \"channels\": [\n \"project_123\",\n \"group_2\"\n ],\n \"disabled\": false,\n \"rateLimit\": 1000,\n \"metadata\": null,\n \"secret\": \"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD\"\n}'"}]}},"/api/v1/app/{app_id}/endpoint/{endpoint_id}/":{"delete":{"description":"Delete an endpoint.","operationId":"delete_endpoint_api_v1_app__app_id__endpoint__endpoint_id___delete","parameters":[{"in":"path","name":"endpoint_id","required":true,"schema":{"description":"The endpoint's ID or UID","example":"ep_1srOrx2ZWZBpBUvZwXKQmoEYga2","maxLength":256,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"Endpoint Id","type":"string"}},{"in":"path","name":"app_id","required":true,"schema":{"description":"The application's ID or UID","example":"app_1srOrx2ZWZBpBUvZwXKQmoEYga2","maxLength":256,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_.]+$","title":"App Id","type":"string"}},{"description":"The request's idempotency key","in":"header","name":"idempotency-key","required":false,"schema":{"description":"The request's idempotency key","nullable":true,"title":"Idempotency-Key","type":"string"}}],"responses":{"204":{"description":"Successful Response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Conflict"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorOut"}}},"description":"Too Many Requests"}},"security":[{"HTTPBearer":[]}],"summary":"Delete Endpoint","tags":["Endpoint"],"x-codeSamples":[{"label":"JavaScript","lang":"JavaScript","source":"await svix.endpoint.delete('app_id', 'endpoint_id');"},{"label":"TypeScript","lang":"JavaScript","source":"await svix.endpoint.delete('app_id', 'endpoint_id');"},{"label":"Python","lang":"Python","source":"svix.endpoint.delete('app_id', 'endpoint_id')"},{"label":"Python (Async)","lang":"Python","source":"await svix.endpoint.delete('app_id', 'endpoint_id')"},{"label":"Go","lang":"Go","source":"err := svixClient.Endpoint.Delete(\"app_id\", \"endpoint_id\")"},{"label":"Kotlin","lang":"Kotlin","source":"svix.endpoint.delete('app_id', 'endpoint_id')"},{"label":"Java","lang":"Java","source":"svix.getEndpoint().delete('app_id', 'endpoint_id')"},{"label":"Ruby","lang":"Ruby","source":"svix.endpoint.delete('app_id', 'endpoint_id')"},{"label":"Rust","lang":"Rust","source":"svix.endpoint().delete(\"app_id\", \"endpoint_id\").await?;"},{"label":"C#","lang":"C#","source":"await svix.Endpoint.DeleteAsync(\"app_id\", \"endpoint_id\")"},{"label":"CLI","lang":"Shell","source":"svix endpoint delete 'app_id' 'endpoint_id'"},{"label":"cURL","lang":"Shell","source":"curl -X 'DELETE' \\\n 'https://api.svix.com/api/v1/app/{app