Skip to main content
GET
/
webhooks
/
{id}
Get Webhook
curl --request GET \
  --url https://api.example.com/webhooks/{id} \
  --header 'Authorization: <authorization>'
{
  "id": "<string>",
  "apiKeyId": "<string>",
  "url": "<string>",
  "name": "<string>",
  "description": "<string>",
  "headers": [
    {}
  ],
  "events": [
    {}
  ],
  "isActive": true,
  "maxRetries": 123,
  "timeoutMs": 123,
  "consecutiveFailures": 123,
  "circuitOpenedAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}
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

curl -X GET https://api.instaview.sk/webhooks/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer sk_your_key_here"

​
Example Response

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "apiKeyId": "api-key-uuid",
    "url": "https://api.example.com/webhooks/instaview",
    "name": "Production Webhook",
    "description": "Receives interview completion notifications",
    "headers": [
      { "name": "Authorization", "isMasked": true },
      { "name": "X-Custom-Header", "isMasked": false }
    ],
    "events": ["interview.completed", "analysis.completed"],
    "isActive": true,
    "maxRetries": 3,
    "timeoutMs": 30000,
    "consecutiveFailures": 0,
    "circuitOpenedAt": null,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

​
Error Responses

{
  "success": false,
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Webhook configuration not found",
    "details": {
      "resourceType": "WebhookConfig",
      "resourceId": "invalid-uuid"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "RESOURCE_ACCESS_DENIED",
    "message": "Access denied to this webhook configuration"
  }
}

List Webhooks

List all webhook configurations

Update Webhook

Update webhook configuration