Skip to content
BuildWorkPro Docs

Get webhook endpoint

GET
/webhook-endpoints/{id}

Returns a single webhook endpoint. The signingSecret field is redacted.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Endpoint

object
data
required
object
id
required
integer
url
required
string
description
required
string | null
eventTypes
required
Array<string>
isActive
required
boolean
consecutiveFailures
required
integer
lastDeliveredAt
required
Any of:
string format: date-time
disabledAt
required
Any of:
string format: date-time
disabledReason
required
string | null
createdAt
required
Any of:
string format: date-time
updatedAt
required
Any of:
string format: date-time
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer

404

Section titled “404 ”

Not found

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string