Endpoint

Upsert Endpoint

Changed on Oct 20, 2026

Create or update an endpoint.

put/api/v1/app/{app_id}/endpoint/{endpoint_id}

Request

Base URL
https://api.eu.svix.com
URL
https://api.eu.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}
Auth
HTTP bearer

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

Request body

channelsstring[] nullable

List of message channels this endpoint listens to (omit for all).

descriptionstring

disabledboolean

eventTypesstring[] nullable

metadataobject

throttleRateinteger nullable

Maximum messages per second to send to this endpoint.

Outgoing messages will be throttled to this rate.

uidstring nullable

Optional unique identifier for the endpoint.

urlstring uri required

Example request

{
  "channels": [
    "project_123",
    "group_2"
  ],
  "description": "An example endpoint name",
  "eventTypes": [
    "user.signup",
    "user.deleted"
  ],
  "uid": "unique-identifier",
  "url": "https://example.com/webhook/"
}

Response

channelsstring[] nullable

List of message channels this endpoint listens to (omit for all).

createdAtstring date-time required

descriptionstring required

disabledboolean

eventTypesstring[] nullable

expirystring date-time nullable

When the endpoint expires, if ever.

No messages are sent to the endpoint after this time.

idstring required

The Endpoint's ID.

metadataobject required