Skip to content

PATCH /v1/webhook-endpoints/{endpointId}

Availability
Private Preview
Method and path
PATCH /v1/webhook-endpoints/{endpointId}
API version
1.0.0-private-preview
Base URL
https://api.torq.finance
Authentication
SecretKey
Idempotency
Not declared by this operation.
Rate limits
Read x-ratelimit-* and x-request-id response headers. Do not hard-code a quota.

Authentication requirements

  • SecretKey

Request examples

terminal
curl -X PATCH 'https://api.torq.finance/v1/webhook-endpoints/sample_endpointid' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer $TORQ_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"url":"https://example.com/torq","eventTypes":["sample_eventtypes"]}'
Run a safe sample

This calls the docs preview and returns sample data shaped by the governed OpenAPI response. It never accepts credentials or changes protocol state.

Run the sample call to inspect a schema-shaped response without credentials or side effects.
Request body
WebhookEndpointRequest

Parameters

endpointId
path
Yes
string

Request schema

WebhookEndpointRequest WebhookEndpointRequest

url
string (uri)
Yes
—
eventTypes
string[]
Yes
—
Inspect nested properties

url string (uri) · required

eventTypes string[] · required

items string

Responses

200
Successful response
WebhookEndpoint
400
Invalid request
TorqApiError
401
Authentication required
TorqApiError
403
Insufficient scope or authority
TorqApiError
409
State or idempotency conflict
TorqApiError
429
Rate limit exceeded
TorqApiError
500
Internal failure
TorqApiError

200 response schema

WebhookEndpoint WebhookEndpoint

id
string
Yes
—
url
string (uri)
Yes
—
eventTypes
string[]
Yes
—
status
enum
Yes
—
Inspect nested properties

id string · required

minimum length: 1 · maximum length: 200

url string (uri) · required

eventTypes string[] · required

items string

status enum · required

one of: active, disabled

400, 401, 403, 409, 429, 500 response schema

TorqApiError TorqApiError

ok
boolean
Yes
—
code
string
Yes
—
message
string
Yes
—
requestId
string
Yes
—
retryable
boolean
Yes
—
blockedReason
string | null
No
—
docsUrl
string (uri)
No
—
Inspect nested properties

ok boolean · required

code string · required

minimum length: 1 · maximum length: 200

message string · required

minimum length: 1 · maximum length: 200

requestId string · required

minimum length: 1 · maximum length: 200

retryable boolean · required

blockedReason string | null · optional

nullable

docsUrl string (uri) · optional

Related guides

For retry behavior and blocked-state handling, see Errors and rate limits.