Svix Environment Settings API
The Environment-Settings API from Svix — 3 operation(s) for environment-settings.
The Environment-Settings API from Svix — 3 operation(s) for environment-settings.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/svix-environment-settings-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Svix Environment Settings 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.922.0
x-logo:
url: https://www.svix.com/static/img/brand-padded.svg
altText: Svix Logo
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: Environment-Settings
paths:
/api/v1/environment/settings:
get:
tags:
- Environment-Settings
summary: Get Org Settings
description: Get the environment's settings.
operationId: v1.environment.get-settings
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentSettingsOut'
'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-internal: true
/api/v1/management/environment-settings:
get:
tags:
- Environment-Settings
summary: Get Dashboard Organization Settings
description: Get the environments's settings
operationId: v1.management.environment-settings.get
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SettingsInternalOut'
'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-internal: true
put:
tags:
- Environment-Settings
summary: Update Dashboard Organization Settings
description: Update the environment's settings
operationId: v1.management.environment-settings.update
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SettingsInternalIn'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SettingsInternalUpdateOut'
'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-internal: true
patch:
tags:
- Environment-Settings
summary: Patch Environment Settings
description: Patch environment settings
operationId: v1.management.environment-settings.patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SettingsInternalPatch'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SettingsInternalOut'
'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-internal: true
/api/v1/management/environment-settings/customer-otel:
get:
tags:
- Environment-Settings
summary: Get Otel Config
description: Get customer otel config.
operationId: v1.management.environment-settings.get-otel-config
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OtelConfigOut'
'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-internal: true
put:
tags:
- Environment-Settings
summary: Update Otel Config
description: Update customer otel config.
operationId: v1.management.environment-settings.update-otel-config
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OtelConfig'
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-internal: true
delete:
tags:
- Environment-Settings
summary: Delete Otel Config
description: Delete customer otel config.
operationId: v1.management.environment-settings.delete-otel-config
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-internal: true
components:
schemas:
BorderRadiusConfig:
type: object
properties:
button:
$ref: '#/components/schemas/BorderRadiusEnum'
nullable: true
card:
$ref: '#/components/schemas/BorderRadiusEnum'
nullable: true
input:
$ref: '#/components/schemas/BorderRadiusEnum'
nullable: true
OtelConfig:
type: object
properties:
url:
type: string
additionalHeaders:
type: object
default: null
additionalProperties:
type: string
nullable: true
required:
- url
SettingsInternalPatch:
type: object
properties:
customColor:
type: string
format: color
nullable: true
customLogoUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
customThemeOverride:
$ref: '#/components/schemas/CustomThemeOverride'
nullable: true
customStringsOverride:
$ref: '#/components/schemas/CustomStringsOverride'
nullable: true
customBaseFontSize:
type: integer
format: int
nullable: true
customFontFamily:
type: string
nullable: true
pattern: ^[a-zA-Z0-9\-_ ]+$
example: Open Sans
customFontFamilyUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
disableEndpointOnFailure:
type: boolean
displayName:
type: string
nullable: true
enableChannels:
type: boolean
enableEndpointMtlsConfig:
type: boolean
enableEndpointOauthConfig:
type: boolean
enableIntegrationManagement:
type: boolean
enableMessageStream:
type: boolean
enableMsgAtmptLog:
type: boolean
enableOtlp:
type: boolean
enableTransformations:
type: boolean
enforceHttps:
type: boolean
eventCatalogPublished:
type: boolean
readOnly:
type: boolean
requireEndpointChannel:
type: boolean
requireEndpointFilterTypes:
type: boolean
retryPolicy:
type: array
items:
type: integer
format: int32
nullable: true
whitelabelHeaders:
type: boolean
sendSvixWebhookHeaders:
type: boolean
colorPaletteLight:
$ref: '#/components/schemas/CustomColorPalette'
nullable: true
colorPaletteDark:
$ref: '#/components/schemas/CustomColorPalette'
nullable: true
showUseSvixPlay:
type: boolean
wipeSuccessfulPayload:
type: boolean
enableApplicationAlerts:
type: boolean
applicationAlertEvents:
type: array
items:
$ref: '#/components/schemas/ApplicationAlertEvent'
applicationAlertsDashboardUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
applicationAlertsLogoUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
showFeatureTooltips:
type: boolean
webhooksAutoConfig:
type: boolean
mcpToken:
type: boolean
ValidationError:
description: Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these per 422 UNPROCESSABLE ENTITY error.
type: object
properties:
loc:
description: The location as a [`Vec`] of [`String`]s -- often in the form `["body", "field_name"]`, `["query", "field_name"]`, etc. They may, however, be arbitrarily deep.
type: array
items:
type: string
msg:
description: The message accompanying the validation error item.
type: string
type:
description: The type of error, often "type_error" or "value_error", but sometimes with more context like as "value_error.number.not_ge"
type: string
required:
- loc
- msg
- type
EnvironmentSettingsOut:
type: object
properties:
customColor:
type: string
format: color
nullable: true
logoUrl:
type: string
format: uri
nullable: true
customLogoUrl:
description: Deprecated, use `logoUrl` instead.
type: string
format: uri
deprecated: true
maxLength: 65536
minLength: 1
nullable: true
customFontFamily:
type: string
nullable: true
pattern: ^[a-zA-Z0-9\-_ ]+$
example: Open Sans
customFontFamilyUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
customThemeOverride:
$ref: '#/components/schemas/CustomThemeOverride'
nullable: true
customStringsOverride:
$ref: '#/components/schemas/CustomStringsOverride'
nullable: true
displayName:
type: string
nullable: true
enableChannels:
type: boolean
default: false
enableMessageTags:
type: boolean
default: false
enableMessageStream:
type: boolean
default: false
enableIntegrationManagement:
type: boolean
default: false
enableTransformations:
type: boolean
default: false
enableEndpointOauthConfig:
type: boolean
default: false
enableEndpointMtlsConfig:
type: boolean
default: false
colorPaletteLight:
$ref: '#/components/schemas/CustomColorPalette'
nullable: true
colorPaletteDark:
$ref: '#/components/schemas/CustomColorPalette'
nullable: true
showUseSvixPlay:
type: boolean
default: true
showSvixBrandFooter:
type: boolean
default: false
wipeSuccessfulPayload:
type: boolean
default: false
showFeatureTooltips:
type: boolean
default: false
FontSizeConfig:
type: object
properties:
base:
type: integer
format: uint16
minimum: 0
nullable: true
HttpErrorOut:
title: HttpError
type: object
properties:
code:
type: string
detail:
type: string
required:
- code
- detail
SettingsInternalOut:
type: object
properties:
showSvixBrandFooter:
type: boolean
default: false
whitelabelLogo:
type: string
format: uri
default: null
nullable: true
retryPolicy:
type: array
items:
type: integer
format: int32
nullable: true
requireEndpointChannel:
type: boolean
default: false
whitelabelHeaders:
type: boolean
default: false
sendSvixWebhookHeaders:
type: boolean
default: false
enableMsgAtmptLog:
type: boolean
default: false
enableOtlp:
type: boolean
default: false
customColor:
type: string
format: color
nullable: true
customLogoUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
customThemeOverride:
$ref: '#/components/schemas/CustomThemeOverride'
nullable: true
customStringsOverride:
$ref: '#/components/schemas/CustomStringsOverride'
nullable: true
customBaseFontSize:
type: integer
format: int
nullable: true
customFontFamily:
type: string
nullable: true
pattern: ^[a-zA-Z0-9\-_ ]+$
example: Open Sans
customFontFamilyUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
disableEndpointOnFailure:
type: boolean
default: true
displayName:
type: string
nullable: true
eventCatalogPublished:
type: boolean
default: false
enforceHttps:
type: boolean
default: true
enableChannels:
type: boolean
default: false
enableMessageStream:
type: boolean
default: false
readOnly:
type: boolean
default: false
enableIntegrationManagement:
type: boolean
default: false
enableTransformations:
type: boolean
default: false
requireEndpointFilterTypes:
type: boolean
default: false
enableEndpointOauthConfig:
type: boolean
default: false
enableEndpointMtlsConfig:
type: boolean
default: false
colorPaletteLight:
$ref: '#/components/schemas/CustomColorPalette'
nullable: true
colorPaletteDark:
$ref: '#/components/schemas/CustomColorPalette'
nullable: true
showUseSvixPlay:
type: boolean
default: true
wipeSuccessfulPayload:
type: boolean
default: false
enableApplicationAlerts:
type: boolean
default: false
applicationAlertEvents:
type: array
default: []
items:
$ref: '#/components/schemas/ApplicationAlertEvent'
applicationAlertsDashboardUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
applicationAlertsLogoUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
showFeatureTooltips:
type: boolean
default: false
webhooksAutoConfig:
type: boolean
default: false
mcpToken:
type: boolean
default: false
SettingsInternalIn:
type: object
properties:
retryPolicy:
type: array
items:
type: integer
format: int32
nullable: true
requireEndpointChannel:
type: boolean
default: false
whitelabelHeaders:
type: boolean
default: false
sendSvixWebhookHeaders:
type: boolean
default: false
enableMsgAtmptLog:
type: boolean
default: false
enableOtlp:
type: boolean
default: false
customColor:
type: string
format: color
nullable: true
customLogoUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
customThemeOverride:
$ref: '#/components/schemas/CustomThemeOverride'
nullable: true
customStringsOverride:
$ref: '#/components/schemas/CustomStringsOverride'
nullable: true
customBaseFontSize:
type: integer
format: int
nullable: true
customFontFamily:
type: string
nullable: true
pattern: ^[a-zA-Z0-9\-_ ]+$
example: Open Sans
customFontFamilyUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
disableEndpointOnFailure:
type: boolean
default: true
displayName:
type: string
nullable: true
eventCatalogPublished:
type: boolean
default: false
enforceHttps:
type: boolean
default: true
enableChannels:
type: boolean
default: false
enableMessageStream:
type: boolean
default: false
readOnly:
type: boolean
default: false
enableIntegrationManagement:
type: boolean
default: false
enableTransformations:
type: boolean
default: false
requireEndpointFilterTypes:
type: boolean
default: false
enableEndpointOauthConfig:
type: boolean
default: false
enableEndpointMtlsConfig:
type: boolean
default: false
colorPaletteLight:
$ref: '#/components/schemas/CustomColorPalette'
nullable: true
colorPaletteDark:
$ref: '#/components/schemas/CustomColorPalette'
nullable: true
showUseSvixPlay:
type: boolean
default: true
wipeSuccessfulPayload:
type: boolean
default: false
enableApplicationAlerts:
type: boolean
default: false
applicationAlertEvents:
type: array
default: []
items:
$ref: '#/components/schemas/ApplicationAlertEvent'
applicationAlertsDashboardUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
applicationAlertsLogoUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
showFeatureTooltips:
type: boolean
default: false
webhooksAutoConfig:
type: boolean
default: false
mcpToken:
type: boolean
default: false
SettingsInternalUpdateOut:
type: object
properties:
retryPolicy:
type: array
items:
type: integer
format: int32
nullable: true
requireEndpointChannel:
type: boolean
default: false
whitelabelHeaders:
type: boolean
default: false
sendSvixWebhookHeaders:
type: boolean
default: false
enableMsgAtmptLog:
type: boolean
default: false
enableOtlp:
type: boolean
default: false
customColor:
type: string
format: color
nullable: true
customLogoUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
customThemeOverride:
$ref: '#/components/schemas/CustomThemeOverride'
nullable: true
customStringsOverride:
$ref: '#/components/schemas/CustomStringsOverride'
nullable: true
customBaseFontSize:
type: integer
format: int
nullable: true
customFontFamily:
type: string
nullable: true
pattern: ^[a-zA-Z0-9\-_ ]+$
example: Open Sans
customFontFamilyUrl:
type: string
format: uri
maxLength: 65536
minLength: 1
nullable: true
disableEndpointOnFailure:
type: boolean
default: true
displayName:
type: string
nullable: true
eventCatalogPublished:
type: boolean
default: false
enforceHttps:
type: boolean
default: true
enableChannels:
type: boolean
default: false
enableMessageStream:
type: boolean
default: false
readOnly:
type: boolean
default: false
enableIntegrationManagement:
type: boolean
default: false
enableTransformations:
type: boolean
default: false
requireEndpointFilterTypes:
type: boolean
default: false
enableEndpointOauthConfig:
# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/svix/refs/heads/main/openapi/svix-environment-settings-api-openapi.yml