v1

latestOpenAPI 3.0.3Proprietary2026-08-0656136286.9 KB

Webhooks

Test Subscription

Test a webhook subscription by sending a test signal. Supports three test modes.

Endpoint: (POST) https://api.lusha.com/api/subscriptions/{id}/test

Test Modes:

direct - Quick HTTP check only (validates URL responds correctly)
kafka - Fanout handler only (tests Kafka message processing)
full - Complete Kafka flow (default - end-to-end test)

Important Notes:

Test deliveries do NOT consume credits
Test payloads use mock data
Useful for verifying webhook configuration before going live

post/api/subscriptions/{id}/test

Path parameters

idstring required

Subscription ID

Query parameters

mode'direct' | 'kafka' | 'full'

Test mode

Response

Test executed successfully

subscriptionIdstring required

subscriptionNamestring

urlstring uri required

mode'direct' | 'kafka' | 'full' required

isSuccessboolean required

timestampstring date-time required

Example response

{
  "subscriptionId": "507f1f77bcf86cd799439011",
  "subscriptionName": "My Test Webhook",
  "url": "https://example.com/webhook",
  "mode": "full",
  "flowCheck": {
    "success": true,
    "statusCode": 200,
    "durationMs": 150
  },
  "testPayload": {
    "entityType": "contact",
    "signalType": "promotion"
  },
  "isSuccess": true,
  "timestamp": "2024-01-01T00:00:00.000Z"
}