---
title: "Send a test webhook event"
method: POST
path: "/api/v1/webhooks/{id}/test"
tags: ["Webhooks"]
---

# Send a test webhook event

`POST /api/v1/webhooks/{id}/test`

## Request

- Base URL: `https://api.korala.ai`
- URL: `https://api.korala.ai/api/v1/webhooks/{id}/test`
- Auth: one of:
  - API key in header `X-API-Key`
  - `bearer` (a scheme the document does not define)

## Path parameters

- `id` string, required

## Response `200`

- WebhookDeliveryDto
  - `id` string, required
  - `webhookId` string, required
  - `eventType` 'risk.context.created' | 'risk.context.subject_added' | 'risk.context.policies_configured' | 'risk.investigation.requested' | 'risk.investigation.completed' | 'risk.investigation.failed' | 'risk.investigation.reviewed' | 'risk.subject.created' | 'risk.policy.created' | 'risk.policy.published' | 'risk.activity.reported' | 'risk.evidence.recorded' | 'risk.evidence.batch_recorded' | 'risk.assessment.created' | 'risk.action.requested' | 'risk.action.transitioned' | 'risk.override.created' | 'risk.override.revoked' | 'screening.run.completed' | 'screening.match.found' | 'screening.adverse_media.run.completed' | 'screening.adverse_media.finding.found' | 'document_created' | 'document_sent' | 'document_viewed' | 'document_signed' | 'document_completed' | 'document_failed' | 'document_voided' | 'document_declined' | 'document_expired' | 'signing_packet.sent' | 'signing_packet.viewed' | 'signing_packet.item_signed' | 'signing_packet.recipient_completed' | 'signing_packet.partially_completed' | 'signing_packet.voided' | 'signing_packet.expired' | 'session_completed' | 'session_expired' | 'session_failed' | 'session_resolved' | 'session_review_required' | 'session_resubmission_requested' | 'session_workflow_completed' | 'session_workflow_failed' | 'workflow_run_completed' | 'workflow_run_failed' | 'test', required
  - `payload` WebhookPayloadDto, required
    - `eventId` string, required: Unique delivery ID
    - `event` 'risk.context.created' | 'risk.context.subject_added' | 'risk.context.policies_configured' | 'risk.investigation.requested' | 'risk.investigation.completed' | 'risk.investigation.failed' | 'risk.investigation.reviewed' | 'risk.subject.created' | 'risk.policy.created' | 'risk.policy.published' | 'risk.activity.reported' | 'risk.evidence.recorded' | 'risk.evidence.batch_recorded' | 'risk.assessment.created' | 'risk.action.requested' | 'risk.action.transitioned' | 'risk.override.created' | 'risk.override.revoked' | 'screening.run.completed' | 'screening.match.found' | 'screening.adverse_media.run.completed' | 'screening.adverse_media.finding.found' | 'document_created' | 'document_sent' | 'document_viewed' | 'document_signed' | 'document_completed' | 'document_failed' | 'document_voided' | 'document_declined' | 'document_expired' | 'signing_packet.sent' | 'signing_packet.viewed' | 'signing_packet.item_signed' | 'signing_packet.recipient_completed' | 'signing_packet.partially_completed' | 'signing_packet.voided' | 'signing_packet.expired' | 'session_completed' | 'session_expired' | 'session_failed' | 'session_resolved' | 'session_review_required' | 'session_resubmission_requested' | 'session_workflow_completed' | 'session_workflow_failed' | 'workflow_run_completed' | 'workflow_run_failed' | 'test', required
    - `timestamp` string, required: ISO 8601 timestamp
    - `data` union, required: Event-specific data
      - DocumentCreatedEventData
        - `documentId` string, required
        - `name` string, required
        - `status` string, required
        - `sandbox` boolean, required
      - DocumentSentEventData
        - `documentId` string, required
        - `name` string, required
        - `signerCount` number, required
        - `sandbox` boolean, required
      - DocumentViewedEventData
        - `documentId` string, required
        - `signerId` string, required
        - `signerEmail` string, nullable
        - `signerExternalId` string, nullable
        - `packetId` string: Present when the signer opened the document in a signing packet: the packet
        - `packetItemId` string: Present when the signer opened the document in a signing packet: the packet item for this document
        - `sandbox` boolean, required
      - DocumentSignedEventData
        - `documentId` string, required
        - `signerId` string, required
        - `signerEmail` string, nullable
        - `signerExternalId` string, nullable
        - `allSigned` boolean, required: Whether all signers have now signed
        - `packetId` string: Present when the signer signed through a signing packet: the packet
        - `packetItemId` string: Present when the signer signed through a signing packet: the packet item for this document
        - `bulkSign` boolean: True when the signature was applied by bulk signing
        - `sandbox` boolean, required
      - DocumentCompletedEventData
        - `documentId` string, required
        - `name` string, required
        - `completedAt` string, required: ISO 8601 timestamp
        - `signerCount` number, required
        - `sandbox` boolean, required
      - DocumentFailedEventData
        - `documentId` string, required
        - `error` string, required
        - `sandbox` boolean, required
      - DocumentVoidedEventData
        - `documentId` string, required
        - `name` string, required
        - `sandbox` boolean, required
      - DocumentDeclinedEventData
        - `documentId` string, required
        - `signerId` string, required
        - `signerEmail` string, nullable
        - `signerExternalId` string, nullable
        - `reason` string, nullable
        - `sandbox` boolean, required
      - TestEventData
        - `sandbox` boolean, required
        - `message` string, required
  - `status` 'pending' | 'success' | 'failed' | 'retrying', required
  - `httpStatusCode` number
  - `requestHeaders` object: Request headers sent with the webhook
  - `responseHeaders` object: Response headers received from the endpoint
  - `responseBody` string
  - `attempts` number, required
  - `nextRetryAt` string, date-time
  - `deliveredAt` string, date-time
  - `createdAt` string, date-time, required

## Other responses

- `400`: Malformed UUID in path parameter (`id`).

---

[API](https://skmtc.dev/korala/apis/korala-public-api.md) · [All operations](https://skmtc.dev/korala/apis/korala-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/korala/apis/korala-public-api/revisions/5c4d7810c507?raw)