Skip to main content
PATCH
Update a webhook endpoint

Authorizations

x-api-key
string
header
default:<api-key>
required

API key issued by Centaur.

Path Parameters

id
string<uuid>
required

Endpoint ID.

Body

application/json

Fields to change. Omitted fields keep their value.

url
string<uri>

New delivery URL, checked like on create. Changing it resets consecutiveFailures.

Maximum string length: 2048
description
string | null

New label, or null to clear it.

Maximum string length: 256
eventTypes
enum<string>[]

Event types the endpoint subscribes to. At least one, no duplicates.

Minimum array length: 1
Available options:
trade_event.created,
trade_event.deleted,
feed_item.created,
feed_item.updated,
feed_item.deleted,
positioning.trending.updated,
positioning.specialist_ideas.updated,
positioning.early_opportunities.updated,
positioning.crowd_fade.updated,
positioning.smart_money.updated,
positioning.leaders_book.updated
filters
object

Replacement subscription filters. {} removes every filter.

maxInFlight
integer

Maximum deliveries sent to this endpoint at the same time, 1 to 50. Defaults to 5.

Required range: 1 <= x <= 50

Response

The updated endpoint

success
enum<boolean>
required
Available options:
true
data
object
required
requestId
string
required
Example:

"c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8"