/api/public/v1/webhookswebhooks.create
Add an https endpoint for chosen events; the signing secret (whsec_…) is returned once.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
command_idbody | string (uuid) | Yes | Client-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. |
urlbody | string | Yes | https:// address on a public host name; port 443, 2053, 2083, 2087, 2096 or 8443 (min length 12, max length 2048) |
descriptionbody | string | No | (max length 200) Default: `""`. |
eventsbody | array<"session.ready" | "session.failed" | "session.closed" | "worker.offline" | "worker.online" | "run.completed" | "feedback.updated"> | Yes | (min 1 items, max 16 items) |
Examples
curl -X POST "https://browlix.com/api/public/v1/webhooks" \
-H "Authorization: Bearer $BROWLIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"command_id":"<uuid>","url":"<url>","events":[]}'Response
201 with { data, replayed: false, correlation_id } the first time; 200 with replayed: true when the same command_id and body come again.
Errors
| Code | HTTP | Retryable |
|---|---|---|
| UNAUTHENTICATED | 401 | No |
| FORBIDDEN | 403 | No |
| RATE_LIMITED | 429 | Yes |
| VALIDATION_FAILED | 422 | No |
| CONFLICT | 409 | No |
| OUTCOME_UNKNOWN | 202 | Yes |
| DEPENDENCY_UNAVAILABLE | 503 | Yes |
| UNKNOWN | 500 | No |