Skip to main content
POST
Reset Circuit Breaker
Resets the circuit breaker for a webhook that was automatically disabled due to consecutive failures.

Overview

When a webhook experiences too many consecutive delivery failures, the circuit breaker automatically opens to prevent further attempts. This endpoint allows you to reset the circuit breaker and re-enable the webhook after you’ve fixed the underlying issue.

Authentication

Authorization
string
required
Bearer token with write:webhooks scope

Path Parameters

id
string
required
The webhook configuration ID (UUID v4)

Response

Returns the updated webhook configuration with reset circuit breaker state.
consecutiveFailures
number
Reset to 0
circuitOpenedAt
string
Reset to null
isActive
boolean
Re-enabled (true)

Example Request

Example Response

Circuit Breaker Workflow

1

Identify Problem

Check consecutiveFailures and circuitOpenedAt to confirm circuit is open
2

Fix Issue

Resolve the underlying problem (endpoint availability, authentication, etc.)
3

Test Endpoint

Use the test endpoint to verify connectivity
4

Reset Circuit

Call this endpoint to re-enable the webhook
5

Monitor

Watch for new failures after reset

Common Causes of Circuit Breaker Trips

  • Server crashed or was redeployed
  • DNS resolution failed
  • Network connectivity issues
Fix: Ensure your endpoint is up and accessible
  • API token expired
  • Custom header value changed
  • Authentication endpoint down
Fix: Update the webhook’s custom headers with valid credentials
  • Endpoint taking too long to respond
  • Long-running synchronous processing
  • Network latency
Fix: Acknowledge webhooks immediately and process asynchronously
  • Application errors (5xx)
  • Validation failures (4xx)
  • Incorrect response format
Fix: Check your application logs and fix the errors

Error Responses

Test Webhook

Test connectivity before resetting

Get Webhook

Check circuit breaker status