Skip to content
Kalipto Devs Platform — API Docs

Test Subscription

POST
/platform/v1/webhooks/subscriptions/{sub_id}/test
 
curl --request POST \
  --url 'https://example.com/platform/v1/webhooks/subscriptions/1/test?event_type=message.received'

Enqueue a SIGNED sample envelope for this subscription.

Validation:

  • event_type must be in PLATFORM_KNOWN_EVENT_TYPES (422).
  • If the subscription has explicit event_types, the sample must be one of them (422 event_not_configured). A catch-all subscription (event_types=[]) accepts any non-wildcard-excluded event; the excluded ones (message.received) ARE allowed for a test (the dev wants to verify the wire) — only the LIVE flow filters them out for catch-all subs.

The sample is persisted as a normal platform_event_deliveries row and dispatched through the same pipeline as a real event.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
sub_id
required
Sub Id
integer

Query Parameters

Section titled “Query Parameters ”
event_type
Event Type

Sample event type to enqueue (must match the subscription’s event_types if explicit)

string
default: message.received

Sample event type to enqueue (must match the subscription’s event_types if explicit)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
PlatformEventDeliveryResponse

Normalized delivery response — wire contract for /platform/v1/webhooks/deliveries/* (W7-Wire).

object
attempts
required
Attempts
integer
conversation_peer
Any of:
string
created_at
Any of:
string format: date-time
delivered_at
Any of:
string format: date-time
developer_account_id
required
Developer Account Id
integer
event_id
required
Event Id
string
event_type
required
Event Type
string
id
required
Id
integer
next_retry_at
Any of:
string format: date-time
platform_channel_id
Any of:
integer
response_body_snippet
Any of:
string
response_status
Any of:
integer
status
required
Status
string
subscription_id
required
Subscription Id
integer
Example generated
{
  "attempts": 1,
  "conversation_peer": "example",
  "created_at": "2026-04-15T12:00:00Z",
  "delivered_at": "2026-04-15T12:00:00Z",
  "developer_account_id": 1,
  "event_id": "example",
  "event_type": "example",
  "id": 1,
  "next_retry_at": "2026-04-15T12:00:00Z",
  "platform_channel_id": 1,
  "response_body_snippet": "example",
  "response_status": 1,
  "status": "example",
  "subscription_id": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}