Sign in

v1

latestOpenAPI 3.0.02026-08-0679302767.4 KB
Webhooks

Test a registered webhook

Send a test event to a registered webhook. This is useful for verifying that the webhook endpoint is reachable and correctly configured.

post/v2/webhooks/{webhookId}/test-event

Path parameters

webhookIdstring required

Webhook ID returned when registering a webhook

Headers

organization-idstring

Request body

messagestring required

Message to include in the test event sent to the webhook

eventType'IN_PROGRESS' | 'PSV_COMPLETED' | 'CREDENTIALING_COMPLETED' | 'PROVIDER_TERMINATED' | 'FACILITY_NOT_SENT_TO_CREDENTIALING' | 'FACILITY_IN_PROGRESS' | 'FACILITY_DATA_MISSING' | 'FACILITY_OUTREACH_IN_PROGRESS' | 'FACILITY_PSV_COMPLETE_BY_CERTIFYOS' | 'FACILITY_CREDENTIALING_RESTARTED' | 'FACILITY_PSV_READY' | 'FACILITY_CRED_APPROVED' | 'FACILITY_HOLD_FOR_CRED_COMM' | 'FACILITY_CRED_DENIED' | 'FACILITY_TERMINATED' | 'FACILITY_RECREDENTIALING_IN_PROGRESS' | 'FACILITY_TABLED' | 'FACILITY_WITHDRAWN_CANCELLED' | 'FACILITY_NOT_STARTED' | 'PROVIDER_NOT_SENT_TO_CREDENTIALING' | 'PROVIDER_NOT_STARTED' | 'PROVIDER_IN_PROGRESS' | 'PROVIDER_DATA_MISSING' | 'PROVIDER_OUTREACH_IN_PROGRESS' | 'PROVIDER_PSV_COMPLETED' | 'PROVIDER_CREDENTIALING_RESTARTED' | 'PROVIDER_PSV_READY' | 'PROVIDER_CRED_APPROVED' | 'PROVIDER_HOLD_FOR_CRED_COMM' | 'PROVIDER_CRED_DENIED' | 'PROVIDER_RECREDENTIALING_IN_PROGRESS' | 'PROVIDER_TABLED' | 'PROVIDER_WITHDRAWN_CANCELLED' | 'FORM_SUBMISSION_CREATED' required

Event type for the test event sent to the webhook

Response

Webhook test event sent successfully

{"stackTrail":"paths:/v2/webhooks/{webhookId}/test-event:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Test event sent successfully"}}

Example response

{
  "message": "Test event sent successfully"
}