Skip to main content
PUT
Update a webhook endpoint

Authorizations

Authorization
string
header
required

Weelkit access token.

Headers

X-Org-Id
string<uuid>
required

The organization the request acts on.

Path Parameters

endpointId
string<uuid>
required

Body

application/json
name
string
required
Maximum string length: 120
url
string<uri>
required
events
string[]
required
isActive
boolean
required

Response

Success.

id
string<uuid>
required
name
string
required
Maximum string length: 120
url
string<uri>
required

HTTPS endpoint. Loopback, private, link-local, and metadata hosts are rejected.

events
enum<string>[]
required
Available options:
article.version.created
isActive
boolean
required
secretVersion
integer
required

Monotonic signing-secret rotation counter.

successRate
number | null
required

Success percentage over the latest 100 recorded deliveries. Null until a delivery has been recorded; unsent queued events do not count.

createdAtUtc
string<date-time>
required
secretRotatedAtUtc
string<date-time> | null
lastDeliveryAtUtc
string<date-time> | null