Skip to main content
POST
/
api
/
v1
/
webhooks
Create Webhook Endpoint
curl --request POST \
  --url https://api.usenexio.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://api.example.com/nexio/webhooks",
  "events": [
    "run.completed",
    "run.failed"
  ],
  "description": "Production callback",
  "auth_token": "token_live_123"
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "url": "https://api.example.com/nexio/webhooks",
  "environment": "live",
  "events": [
    "run.completed",
    "run.failed"
  ],
  "description": "Production callback",
  "active": true,
  "auth_token_configured": true,
  "webhook_version": "2026-03-22",
  "secret": "whsec_abc123def456",
  "created_at": "2026-03-22T12:00:00Z",
  "updated_at": "2026-03-22T12:00:00Z"
}

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.

Body

application/json
​
url
string<uri>
required

HTTPS endpoint URL to receive webhook deliveries.

​
events
enum<string>[]
required

Event types to subscribe to.

Minimum array length: 1
Available options:
run.completed,
run.failed
​
description
string

Optional human-readable description.

Maximum string length: 256
​
active
boolean
default:true

Whether the endpoint starts active. Defaults to true.

​
auth_token
string

Optional bearer token included as Authorization: Bearer <token> on outbound deliveries.

Maximum string length: 1024

Response

Endpoint created. Secret is included only in this response.

​
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.

​
secret
string
required

HMAC-SHA256 signing secret (whsec_...). Displayed only once. Store it securely.

​
description
string

Human-readable description.

​
updated_at
string<date-time>

RFC 3339 last-update timestamp.