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

idstring required

Response

idstring required
webhookIdstring 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
status'pending' | 'success' | 'failed' | 'retrying' required
httpStatusCodenumber
requestHeadersobject

Request headers sent with the webhook

responseHeadersobject

Response headers received from the endpoint

responseBodystring
attemptsnumber required
nextRetryAtstring date-time
deliveredAtstring date-time
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.