PUT
/
api
/
v1
/
open
/
callbacks
/
endpoints
/
{endpoint_id}
Update or rotate callback URL
curl --request PUT \
  --url https://api.example.com/api/v1/open/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": "db232c4a-82e7-4d4c-b49f-022c94f5db67",
  "tenant_id": "tenant_001",
  "name": "production-webhook",
  "url": "https://partner.example.com/utmos/callbacks",
  "status": "ACTIVE",
  "secret": "rotated-secret-returned-once",
  "timeout_seconds": 5,
  "max_attempts": 12,
  "request_id": "req-001"
}

Authorizations

​
X-Api-Signature
string
header
required

HMAC signature; X-Api-Id, X-Api-Timestamp, and X-Api-Nonce are also required.

Headers

​
X-Api-Id
string
required

API credential ID.

​
X-Api-Timestamp
string
required

Unix timestamp in seconds.

​
X-Api-Nonce
string
required

Replay-protection nonce.

​
X-Api-Signature
string
required

HMAC request signature.

​
X-Request-Id
string

Optional correlation ID.

Path Parameters

​
endpoint_id
string
required

Callback URL ID

Body

application/json
​
name
string
required
Example:

"production-webhook"

​
url
string<uri>
required
Example:

"https://partner.example.com/utmos/callbacks"

​
status
enum<string>
required
Available options:
ACTIVE,
DISABLED
Example:

"ACTIVE"

​
rotate_secret
boolean
Example:

false

​
timeout_seconds
integer
Required range: x >= 1
Example:

5

​
max_attempts
integer
Required range: x >= 1
Example:

12

Response

Endpoint updated.

​
endpoint_id
string<uuid>
required
​
tenant_id
string
required
​
name
string
required
​
url
string<uri>
required
​
status
enum<string>
required
Available options:
ACTIVE,
DISABLED
Example:

"ACTIVE"

​
timeout_seconds
integer
required
​
max_attempts
integer
required
​
request_id
string
required
​
secret
string

Returned only when created or rotated