Skip to main content
PATCH
/
v1
/
webhooks
/
endpoints
/
{endpointId}
cURL
curl --request PATCH \
  --url https://api.nxos.io/v1/webhooks/endpoints/{endpointId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "description": "<string>",
  "disabled": true
}
'
{
  "object": "webhook_endpoint",
  "id": "ep_a1b2c3d4e5f6a1b2c3d4e5f6",
  "url": "https://example.com/webhooks/nxos",
  "description": "Production receiver",
  "disabled": false,
  "eventTypes": [
    "transaction.status.updated"
  ],
  "createdAt": "2026-06-08T12:00:00Z",
  "updatedAt": "2026-06-08T12:00:00Z"
}

Headers

​
Authorization
string
required

Bearer token. Format: Bearer <api_key>

Path Parameters

​
endpointId
string
required

Body

application/json

Request body for updating a webhook endpoint. Omitted fields are left unchanged.

​
url
string

HTTPS URL that will receive webhook deliveries.

​
eventTypes
string[]

Event types to subscribe to. Replaces the current subscription set.

​
description
string

Human-readable description.

​
disabled
boolean

Disable or re-enable the endpoint without deleting it.

Response

The request has succeeded.

A registered webhook endpoint. Delivery, retries, and signing are handled by Svix.

​
object
enum<string>
required

Object type. Always webhook_endpoint.

Available options:
webhook_endpoint
​
id
string
required

Unique endpoint identifier.

​
url
string
required

HTTPS URL that receives webhook deliveries.

​
description
string
required

Optional human-readable description.

​
disabled
boolean
required

When true, the endpoint stays registered but receives no deliveries.

​
eventTypes
string[]
required

Event types this endpoint is subscribed to. Empty means all event types.

​
createdAt
string
required

When the endpoint was created.

​
updatedAt
string
required

When the endpoint was last updated.