Skip to main content

WebhookListResponse

Schema for webhook list response

webhooks object[]required
  • Array [
  • 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
  • ]
  • pagination objectrequired
    property name*any
    WebhookListResponse
    {
    "webhooks": [
    {
    "id": "string",
    "name": "string",
    "description": "string",
    "url": "string",
    "events": [
    "string"
    ],
    "headers": {},
    "auth_type": "string",
    "method": "string",
    "content_type": "string",
    "custom_payload_template": "string",
    "is_active": true,
    "max_retries": 0,
    "timeout_seconds": 0,
    "rate_limit_per_minute": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "last_triggered_at": "2024-07-29T15:51:28.071Z",
    "total_deliveries": 0,
    "successful_deliveries": 0,
    "failed_deliveries": 0,
    "success_rate": 0
    }
    ],
    "pagination": {}
    }