Skip to main content

WebhookDeliveryListResponse

Schema for webhook delivery list response

deliveries object[]required
  • Array [
  • idId (string)required
    webhook_id objectrequired
    anyOf
    string
    geofence_id objectrequired
    anyOf
    string
    event_typeEvent Type (string)required
    event_idEvent Id (string)required
    urlUrl (string)required
    methodMethod (string)required
    statusDeliveryStatusEnum (string)required

    Webhook delivery status

    Possible values: [pending, success, failed]

    response_status_code objectrequired
    anyOf
    integer
    response_status object
    anyOf
    integer
    response_time_ms objectrequired
    anyOf
    number
    error_message objectrequired
    anyOf
    string
    attempt_countAttempt Count (integer)required
    retry_countRetry Count (integer)
    Default value: 0
    created_atstring<date-time>required
    delivered_at objectrequired
    anyOf
    string<date-time>
    next_retry_at objectrequired
    anyOf
    string<date-time>
  • ]
  • pagination objectrequired
    property name*any
    WebhookDeliveryListResponse
    {
    "deliveries": [
    {
    "id": "string",
    "webhook_id": "string",
    "geofence_id": "string",
    "event_type": "string",
    "event_id": "string",
    "url": "string",
    "method": "string",
    "status": "pending",
    "response_status_code": 0,
    "response_status": 0,
    "response_time_ms": 0,
    "error_message": "string",
    "attempt_count": 0,
    "retry_count": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "delivered_at": "2024-07-29T15:51:28.071Z",
    "next_retry_at": "2024-07-29T15:51:28.071Z"
    }
    ],
    "pagination": {}
    }