PUT
/
api
/
v1
/
platform
/
tenants
/
{tenant_id}
/
callbacks
/
endpoints
/
{endpoint_id}
Update or rotate callback endpoint
curl --request PUT \
  --url https://api.example.com/api/v1/platform/tenants/{tenant_id}/callbacks/endpoints/{endpoint_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Id: <x-api-id>' \
  --header 'X-Api-Nonce: <x-api-nonce>' \
  --header 'X-Api-Signature: <api-key>' \
  --header 'X-Api-Timestamp: <x-api-timestamp>' \
  --data '
{
  "name": "production-webhook",
  "url": "https://partner.example.com/utmos/callbacks",
  "status": "ACTIVE",
  "rotate_secret": true,
  "timeout_seconds": 5,
  "max_attempts": 12
}
'
{
  "endpoint_id": "callback_endpoint_001",
  "tenant_id": "tenant_001",
  "name": "production-webhook",
  "url": "https://partner.example.com/utmos/callbacks",
  "status": "ACTIVE",
  "secret": "returned_once_on_create_or_rotate",
  "timeout_seconds": 5,
  "max_attempts": 12,
  "request_id": "req-001"
}

Authorizations

X-Api-Signature
string
header
required

UTMOS HMAC request signature with X-Api-Id, X-Api-Timestamp and X-Api-Nonce.

Headers

X-Api-Id
string
required

Platform or tenant administrator credential

X-Api-Timestamp
string
required

Unix seconds

X-Api-Nonce
string
required

Replay-protection nonce

X-Api-Signature
string
required

HMAC signature

X-Request-Id
string

Caller correlation ID; generated when omitted

Path Parameters

tenant_id
string
required

Tenant identifier

endpoint_id
string
required

Callback endpoint identifier

Body

application/json
name
string
required
url
string<uri>
required
status
enum<string>
Available options:
ACTIVE,
DISABLED,
DELETED
rotate_secret
boolean
timeout_seconds
integer
default:5
max_attempts
integer
default:12

Response

OK

endpoint_id
string
tenant_id
string
name
string
url
string
status
enum<string>
Available options:
ACTIVE,
DISABLED,
DELETED
secret
string
timeout_seconds
integer
max_attempts
integer
request_id
string