Skip to main content

WebhookResponse

Schema for webhook response

idId (string)required
nameName (string)required
description objectrequired
anyOf
string
urlUrl (string)required
eventsstring[]required
headers objectrequired
property name*string
auth_typeAuth Type (string)required
methodMethod (string)required
content_typeContent Type (string)required
custom_payload_template objectrequired
anyOf
string
is_activeIs Active (boolean)required
max_retriesMax Retries (integer)required
timeout_secondsTimeout Seconds (integer)required
rate_limit_per_minuteRate Limit Per Minute (integer)required
created_atstring<date-time>required
updated_atstring<date-time>required
last_triggered_at objectrequired
anyOf
string<date-time>
total_deliveriesTotal Deliveries (integer)required
successful_deliveriesSuccessful Deliveries (integer)required
failed_deliveriesFailed Deliveries (integer)required
success_rate objectrequired
anyOf
number
WebhookResponse
{
  "auth_type": "bearer",
  "content_type": "application/json",
  "created_at": "2025-10-01T12:00:00Z",
  "custom_payload_template": null,
  "description": "Notifies dispatch when vehicles enter warehouse zones",
  "events": [
    "enter",
    "exit"
  ],
  "failed_deliveries": 2,
  "headers": {
    "X-Custom-Header": "fleet-tracker"
  },
  "id": "w1a2b3c4-d5e6-7890-abcd-ef1234567890",
  "is_active": true,
  "last_triggered_at": "2025-10-01T14:30:00Z",
  "max_retries": 3,
  "method": "POST",
  "name": "Fleet Entry Alerts",
  "rate_limit_per_minute": 60,
  "success_rate": 98.59,
  "successful_deliveries": 140,
  "timeout_seconds": 30,
  "total_deliveries": 142,
  "updated_at": "2025-10-01T12:00:00Z",
  "url": "https://example.com/webhooks/geofence-events"
}