Skip to main content
PATCH/api/public/v1/webhooks/{id}

webhooks.update

Change URL, description or events, or enable/disable (disabling fails pending deliveries); optional expected revision.

Capability: webhook.manageCommand (idempotent)MCP tool: webhooks_update
View as Markdown

Parameters

NameTypeRequiredDescription
idpathstring (uuid)YesWebhook id
command_idbodystring (uuid)YesClient-generated UUID for this command. Send the same id (and body) again to get the stored receipt instead of a second change; a different body under the same id is CONFLICT.
expected_revisionbodyintegerNoThe revision you last read; a newer revision on the server is CONFLICT (min 1, max 9007199254740991)
urlbodystringNo(min length 12, max length 2048)
descriptionbodystringNo(max length 200)
eventsbodyarray<"session.ready" | "session.failed" | "session.closed" | "worker.offline" | "worker.online" | "run.completed" | "feedback.updated">No(min 1 items, max 16 items)
enabledbodybooleanNo

Examples

curl -X PATCH "https://browlix.com/api/public/v1/webhooks/<id>" \
  -H "Authorization: Bearer $BROWLIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command_id":"<uuid>"}'

Response

201 with { data, replayed: false, correlation_id } the first time; 200 with replayed: true when the same command_id and body come again.

The field list of this reply is not published yet; read data as JSON.

Errors

CodeHTTPRetryable
UNAUTHENTICATED401No
FORBIDDEN403No
RATE_LIMITED429Yes
VALIDATION_FAILED422No
NOT_FOUND404No
CONFLICT409No
OUTCOME_UNKNOWN202Yes
DEPENDENCY_UNAVAILABLE503Yes
UNKNOWN500No

Every error code and when to retry

All operations