boundry.
RegionSydney, Australia
Documentation/Update a webhook
PATCH/webhooks/{webhookId}

Update a webhook

Authentication

Bearer authentication is required for this operation.

Path parameters

NameTypeDescription
webhookIdrequiredstring

Webhook identifier.

Request body

FieldTypeDescription
descriptionstring | null | null

Replacement endpoint description, or null to clear it.

Option 1string

Optional endpoint description.

Option 2null | null

One permitted response shape.

endpointstring (uri)

Replacement webhook endpoint URL.

eventsarray

Replacement event subscriptions.

headersobject

Replacement static endpoint headers; use an empty object to clear them.

statusstring

Replacement endpoint status. Values: "enabled", "disabled", "pending".

Request examples

request.sh
bash
curl --request PATCH 'https://api.au.boundry.dev/webhooks/string' \
+  -H 'Authorization: Bearer $BOUNDRY_API_KEY' \
+  -H 'Content-Type: application/json' \
+  --data '{"endpoint":"https://hooks.acme.com/boundry-v2","webhookId":"wh_01j0example"}'

200 response

Updated webhook.

FieldTypeDescription
api_versionrequiredstring

API version pinned to this endpoint. Values: "2026-08-14".

consecutive_failuresrequiredinteger

Consecutive delivery failures.

created_atrequiredstring (date-time)

Timestamp when the webhook was created. Example: "2026-08-14T12:00:00.000Z".

descriptionrequiredstring | null | null

Optional endpoint description.

Option 1string

Optional endpoint description.

Option 2null | null

One permitted response shape.

endpointrequiredstring (uri)

Webhook delivery endpoint URL. Example: "https://hooks.acme.com/boundry".

eventsrequiredarray

Subscribed event types.

idrequiredstring

Webhook identifier. Example: "msg_01j0example".

last_failure_atrequiredstring (date-time) | null | null

Timestamp of the last failed delivery, or null.

Option 1string (date-time)

Timestamp of the last failed delivery.

Option 2null | null

One permitted response shape.

last_success_atrequiredstring (date-time) | null | null

Timestamp of the last successful delivery, or null.

Option 1string (date-time)

Timestamp of the last successful delivery.

Option 2null | null

One permitted response shape.

objectrequiredstring

Resource type discriminator. Values: "webhook".

secret_prefixrequiredstring

Non-secret signing-secret prefix. Example: "whsec_example".

statusrequiredstring

Webhook state. Values: "enabled", "disabled", "pending".

updated_atrequiredstring (date-time)

Timestamp when the webhook was last updated. Example: "2026-08-14T12:00:00.000Z".

response.jsonExample response
application/json
{
  "endpoint": "https://hooks.acme.com/boundry-v2",
  "webhookId": "wh_01j0example"
}

400 response

Request body was not valid JSON.

FieldTypeDescription
errorsarray

Detailed validation issues. Absent only for the historical 401 API-key envelope.

coderequiredstring

Zod validation issue code. Example: "invalid_format".

messagerequiredstring

Human-readable validation failure. Example: "Invalid email address".

pathrequiredstring

Dot-separated location of the invalid value. Example: "from".

messagerequiredstring

Human-readable error message. Example: "Request validation failed.".

namerequiredstring

Machine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".

response.jsonExample response
application/json
{
  "endpoint": "https://hooks.acme.com/boundry-v2",
  "webhookId": "wh_01j0example"
}

401 response

Invalid API key.

FieldTypeDescription
errorsarray

Detailed validation issues. Absent only for the historical 401 API-key envelope.

coderequiredstring

Zod validation issue code. Example: "invalid_format".

messagerequiredstring

Human-readable validation failure. Example: "Invalid email address".

pathrequiredstring

Dot-separated location of the invalid value. Example: "from".

messagerequiredstring

Human-readable error message. Example: "Request validation failed.".

namerequiredstring

Machine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".

response.jsonExample response
application/json
{
  "endpoint": "https://hooks.acme.com/boundry-v2",
  "webhookId": "wh_01j0example"
}

404 response

Webhook, delivery, or event not found.

FieldTypeDescription
errorsarray

Detailed validation issues. Absent only for the historical 401 API-key envelope.

coderequiredstring

Zod validation issue code. Example: "invalid_format".

messagerequiredstring

Human-readable validation failure. Example: "Invalid email address".

pathrequiredstring

Dot-separated location of the invalid value. Example: "from".

messagerequiredstring

Human-readable error message. Example: "Request validation failed.".

namerequiredstring

Machine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".

response.jsonExample response
application/json
{
  "endpoint": "https://hooks.acme.com/boundry-v2",
  "webhookId": "wh_01j0example"
}

422 response

Request validation failed.

FieldTypeDescription
errorsarray

Detailed validation issues. Absent only for the historical 401 API-key envelope.

coderequiredstring

Zod validation issue code. Example: "invalid_format".

messagerequiredstring

Human-readable validation failure. Example: "Invalid email address".

pathrequiredstring

Dot-separated location of the invalid value. Example: "from".

messagerequiredstring

Human-readable error message. Example: "Request validation failed.".

namerequiredstring

Machine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".

response.jsonExample response
application/json
{
  "endpoint": "https://hooks.acme.com/boundry-v2",
  "webhookId": "wh_01j0example"
}