Skip to main content
POST
Update webhook endpoint

Authorizations

api-key
string
header
required

Body

application/json
endpointId
string
required

ID of the endpoint to update

Required string length: 1 - 256
url
string

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
filterTypes
enum<string>[]

Only deliver events matching these types. Omit to keep current filter. Pass an empty array 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. Omit to keep current channels.

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

Max events per second delivered to this endpoint. Omit to keep current limit.

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

Set to true to pause delivery to this endpoint without deleting it

metadata
object

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

Response

Ok

id
string
required

Unique identifier for this endpoint

url
string
required

The HTTPS URL where webhook payloads are delivered

description
string
required

Label for this endpoint

filterTypes
enum<string>[] | null
required

Event types this endpoint is subscribed to, or null if subscribed to all

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[] | null
required

Channels this endpoint listens on, or null if listening on all

throttleRate
number<double> | null
required

Max events per second delivered to this endpoint, or null for unlimited

disabled
boolean
required

Whether delivery to this endpoint is paused

metadata
object
required

Arbitrary key-value pairs attached to this endpoint

createdAt
string
required

ISO 8601 timestamp when the endpoint was created

updatedAt
string
required

ISO 8601 timestamp when the endpoint was last modified