Skip to main content
GET
Get webhook endpoint

Authorizations

api-key
string
header
required

Path Parameters

endpointId
string
required

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