Skip to main content
POST
Create a webhook endpoint

Authorizations

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

API key issued by Centaur.

Body

application/json

A new webhook endpoint.

url
string<uri>
required

HTTPS URL that receives deliveries as signed POST requests. Its host must be public: a host that is or resolves to a private, loopback, link-local or cloud metadata address is rejected, and URLs with a username or password are rejected.

Maximum string length: 2048
eventTypes
enum<string>[]
required

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
description
string

Your label for the endpoint. Display only.

Maximum string length: 256
filters
object

Subscription filters. Omit for no filtering. Applies to trade_event.* and feed_item.* deliveries only.

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 created endpoint with its signing secret

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

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