{
"is_active": true
}
{
"events": [
"inventory_transaction.completed",
"inventory_transaction.failed"
]
}
{
"endpoint": {
"id": "wep_01j5k...",
"url": "https://yourapp.com/webhooks/boh",
"events": ["inventory_transaction.completed", "inventory_transaction.failed"],
"is_active": true,
"consecutive_failures": 0,
"updated_at": "2026-08-07T15:00:00.000Z"
}
}
Webhooks
Update webhook
Partially updates a webhook endpoint. Use this to change the URL, update the event list, or re-enable an auto-disabled endpoint.
PATCH
/
api
/
v1
/
public
/
admin
/
webhooks
/
{webhookId}
{
"is_active": true
}
{
"events": [
"inventory_transaction.completed",
"inventory_transaction.failed"
]
}
{
"endpoint": {
"id": "wep_01j5k...",
"url": "https://yourapp.com/webhooks/boh",
"events": ["inventory_transaction.completed", "inventory_transaction.failed"],
"is_active": true,
"consecutive_failures": 0,
"updated_at": "2026-08-07T15:00:00.000Z"
}
}
string
required
BOH API key with
admin:webhooks scope.string
required
Webhook endpoint UUID.
string
New HTTPS URL.
string[]
New event subscription list (replaces the existing list).
boolean
Set
true to re-enable an auto-disabled endpoint. Setting false manually disables it.object
Updated webhook endpoint.
{
"is_active": true
}
{
"events": [
"inventory_transaction.completed",
"inventory_transaction.failed"
]
}
{
"endpoint": {
"id": "wep_01j5k...",
"url": "https://yourapp.com/webhooks/boh",
"events": ["inventory_transaction.completed", "inventory_transaction.failed"],
"is_active": true,
"consecutive_failures": 0,
"updated_at": "2026-08-07T15:00:00.000Z"
}
}