Skip to main content
POST
Register webhook endpoint

Authorizations

api-key
string
header
required

Body

application/json
url
string
required

The HTTPS URL where webhook payloads will be sent via POST

Pattern: ^https://
Example:

"https://api.example.com/webhooks"

description
string

A label for this endpoint, visible in the dashboard and API responses

Maximum string length: 256
Example:

"Production bid notifications"

filterTypes
enum<string>[]

Only deliver events matching these types. Omit to receive all event types.

Maximum array length: 50

Event types available for webhook subscriptions. Use these values in filterTypes to receive only specific events.

Available options:
bid.created,
bid.accepted,
bid.rejected,
bid.revoked,
bid.closed,
bid.countered,
bid.counter_accepted,
bid.counter_revoked,
bid.counter_rejected
channels
string[]

Channels to subscribe to (e.g. app installation IDs to scope delivery). Omit to receive events on all channels.

Maximum array length: 50
throttleRate
integer<int32> | null

Max events per second delivered to this endpoint. Omit for unlimited.

Required range: 1 <= x <= 1000
disabled
boolean

Set to true to create the endpoint in a paused state

metadata
object

Arbitrary key-value pairs to attach to this endpoint. Maximum 50 entries.

secret
string | null

Provide your own signing secret. Omit to have one generated automatically.

Required string length: 1 - 256

Response

Ok

endpoint
object
required

The newly created endpoint

secret
string
required

Signing secret for verifying webhook payloads. Store this securely — it is only returned at registration time.