Skip to content
BuildWorkPro Docs

Create webhook endpoint

POST
/webhook-endpoints

Creates a new webhook endpoint. The url is SSRF-validated before creation. The signingSecret is returned in the response exactly once — store it now, it cannot be retrieved later.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string

Request Body

Section titled “Request Body ”
object
url
required
string
>= 1 characters
eventTypes
required
Array<string>
>= 1 items <= 29 items
Allowed values: bid.created bid.updated bid.deleted bid.accepted bid.acceptance_reverted bid.rejected bid.expired project.created project.updated project.deleted project.status_changed pay_app.submitted pay_app.approved pay_app.rejected pay_app.paid pay_app.updated pay_app.deleted change_order.submitted change_order.approved change_order.rejected change_order.voided change_order.updated change_order.deleted contact.created contact.updated contact.deleted lead.created lead.updated lead.deleted
description
string | null
<= 2000 characters

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

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
signingSecret
required
string
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

422

Section titled “422 ”

Validation failed

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