Skip to main content
GET
Get Webhook
Returns a single webhook configuration by ID.

Overview

Retrieve detailed information about a specific webhook configuration, including its health status, subscribed events, and configuration details.

Authentication

Authorization
string
required
Bearer token with read:webhooks scope

Path Parameters

id
string
required
The webhook configuration ID (UUID v4)

Response

id
string
Unique identifier for the webhook
apiKeyId
string
The API key ID this webhook belongs to
url
string
The endpoint URL receiving webhook notifications
name
string
Human-readable name for the webhook
description
string
Description of the webhook’s purpose
headers
array
Custom headers configured for this webhook. Sensitive header values are masked.
events
array
Array of subscribed event type labels
isActive
boolean
Whether the webhook is currently active
maxRetries
number
Maximum retry attempts for failed deliveries
timeoutMs
number
Request timeout in milliseconds
consecutiveFailures
number
Current count of consecutive delivery failures
circuitOpenedAt
string
ISO 8601 timestamp when circuit breaker was triggered (null if closed)
createdAt
string
ISO 8601 timestamp when webhook was created
updatedAt
string
ISO 8601 timestamp when webhook was last updated

Example Request

Example Response

Error Responses

List Webhooks

List all webhook configurations

Update Webhook

Update webhook configuration