Get a webhook by id

Retrieves details for a specific webhook. Requires webhook:read scope.

GET /api/v0/webhooks/{id}

Get a webhook by id

cURL

curl --request GET \
  --url https://api.devdraft.ai/api/v0/webhooks/{id} \
  --header 'x-client-secret: <api-key>'

200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Payment Notifications",
  "url": "https://api.example.com/webhooks/payments",
  "isActive": true,
  "encrypted": false,
  "created_at": "2024-03-20T12:00:00.000Z",
  "updated_at": "2024-03-20T12:00:00.000Z",
  "delivery_stats": {
    "total_events": 150,
    "successful_deliveries": 145,
    "failed_deliveries": 5,
    "last_delivery": "2024-03-20T11:55:00.000Z"
  }
}

Authorizations

x-client-secretx-client-key

x-client-secret · string · header · required

Your secret API key. Keep this secure and never expose it in client-side code.

Path Parameters

id · string<uuid> · required

Webhook unique identifier (UUID)

Response

200

application/json

Return the webhook.

id · string · required

Unique identifier for the webhook

Example:

"550e8400-e29b-41d4-a716-446655440000"

name · string · required

Name of the webhook

Example:

"Payment Notifications"

url · string · required

URL where webhook events are sent

Example:

"https://api.example.com/webhooks/payments"

isActive · boolean · required

Whether the webhook is currently active

Example:

true

encrypted · boolean · required

Whether webhook payloads are encrypted

Example:

false

created_at · string · required

Timestamp when the webhook was created

Example:

"2024-03-20T12:00:00.000Z"

updated_at · string · required

Timestamp when the webhook was last updated

Example:

"2024-03-20T12:00:00.000Z"

delivery_stats · object · required

Webhook delivery statistics

Example:

{
  "total_events": 150,
  "successful_deliveries": 145,
  "failed_deliveries": 5,
  "last_delivery": "2024-03-20T11:55:00.000Z"
}