A valid request URL is required to generate request examples{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"events": [],
"headers": {},
"include_response": true,
"allow_private_network": true,
"disabled": true,
"max_retries": 123,
"retry_backoff_initial_seconds": 123,
"retry_backoff_max_seconds": 123,
"attempt_timeout_seconds": 123,
"max_response_payload_kbs": 123,
"max_concurrent_deliveries": 123,
"consecutive_failures": 123,
"last_success_at": "2023-11-07T05:31:56Z",
"last_failure_at": "2023-11-07T05:31:56Z",
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"model_requested": "<string>",
"request_type": "<string>"
}
}Update a webhook endpoint
Updates a webhook endpoint. The signing secret is immutable here — use the rotate-secret endpoint to change it.
A valid request URL is required to generate request examples{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"events": [],
"headers": {},
"include_response": true,
"allow_private_network": true,
"disabled": true,
"max_retries": 123,
"retry_backoff_initial_seconds": 123,
"retry_backoff_max_seconds": 123,
"attempt_timeout_seconds": 123,
"max_response_payload_kbs": 123,
"max_concurrent_deliveries": 123,
"consecutive_failures": 123,
"last_success_at": "2023-11-07T05:31:56Z",
"last_failure_at": "2023-11-07T05:31:56Z",
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"model_requested": "<string>",
"request_type": "<string>"
}
}Authorizations
Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>.
Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.
Path Parameters
The webhook endpoint id.
Body
Create or update body for a webhook endpoint. The signing secret is never accepted here — it is generated by the server and returned once at creation, and can only be changed through the rotate-secret endpoint.
Unique endpoint name.
Delivery URL. HTTPS is required unless allow_private_network is set.
Events this endpoint subscribes to.
A terminal async-job event a webhook endpoint can subscribe to:
- async_job.completed: an async job finished successfully
- async_job.failed: an async job finished with an error
async_job.completed, async_job.failed Custom headers sent with every delivery. Values support env var syntax ("env.MY_VAR") and are encrypted at rest. Reserved delivery headers (webhook-id, webhook-timestamp, webhook-signature, content-type, etc.) cannot be overridden.
Show child attributes
Show child attributes
Inline the job response into delivery payloads, capped by max_response_payload_kbs.
Permit private-network receivers and plain http. Link-local and metadata addresses stay blocked.
Register the endpoint without delivering to it.
Retries after the first failed attempt (default 4). 0 selects the default.
x >= 0Delay before the first retry; each further retry doubles it (default 30). 0 selects the default.
x >= 0Cap on the per-retry delay (default 1800). 0 selects the default.
x >= 0End-to-end bound for one delivery attempt (default 10). 0 selects the default.
x >= 0Cap for inlined response payloads in KB when include_response is set (default 256). 0 selects the default.
x >= 0Concurrent in-flight deliveries to this endpoint per node (default 10). 0 selects the default.
x >= 0Response
The updated webhook endpoint
A registered webhook endpoint. The signing secret is never included in this representation; custom header values are redacted.
A terminal async-job event a webhook endpoint can subscribe to:
- async_job.completed: an async job finished successfully
- async_job.failed: an async job finished with an error
async_job.completed, async_job.failed Custom delivery header values, redacted.
Show child attributes
Show child attributes
Number of consecutive failed deliveries; reset on the next success.
Was this page helpful?