Skip to main content
PATCH
/
api
/
v1
/
webhooks
/
{endpointID}
Update Webhook Endpoint
curl --request PATCH \
  --url https://api.usenexio.com/api/v1/webhooks/{endpointID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://api.example.com/nexio/webhooks/v2",
  "active": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "environment": "test",
  "events": [
    "run.completed"
  ],
  "active": true,
  "auth_token_configured": true,
  "webhook_version": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key with environment prefix. Use nx_test_... for sandbox and nx_live_... for production. Obtain keys at platform.usenexio.com/settings/api-keys.

Path Parameters

​
endpointID
string<uuid>
required

Webhook endpoint UUID.

Body

application/json

At least one field is required.

​
url
string<uri>
​
events
enum<string>[]
Minimum array length: 1
Available options:
run.completed,
run.failed
​
description
string | null
Maximum string length: 256
​
active
boolean
​
auth_token
string | null

Set to null to clear the bearer token.

Maximum string length: 1024

Response

Updated endpoint.

​
id
string<uuid>
required

Endpoint identifier.

​
url
string<uri>
required

Delivery target URL.

​
environment
enum<string>
required

Environment this endpoint receives events from.

Available options:
test,
live
​
events
enum<string>[]
required

Subscribed event types.

Available options:
run.completed,
run.failed
​
active
boolean
required

Whether the endpoint is active.

​
auth_token_configured
boolean
required

Whether an auth token is set (the token value is never returned).

​
webhook_version
string
required

Payload version string (e.g. 2026-03-22).

​
created_at
string<date-time>
required

RFC 3339 creation timestamp.

​
description
string

Human-readable description.

​
updated_at
string<date-time>

RFC 3339 last-update timestamp.