Send a test ping to a webhook endpoint

{
  "id": "evt_9TqLp4XcRr",
  "type": "screening.completed",
  "created": "2026-06-11T14:11:48Z",
  "org_id": "org_4Nv8sJqKfH",
  "external_ref": "cl_app_84321",
  "data": {
    "object": {
      "id": "scr_7Hq2mNfA8b",
      "candidate_id": "cand_5DkW9rTzPe",
      "external_ref": "cl_app_84321",
      "job_id": "job_2VbY6mQwXs",
      "status": "completed",
      "stage": "passed_screening_awaiting_scheduling",
      "attempt_count": 1,
      "next_attempt_at": null,
      "started_at": "2026-06-11T14:03:22Z",
      "completed_at": "2026-06-11T14:11:47Z",
      "outcome": "passed",
      "result": {
        "answers": [
          {
            "question": "Do you have an active Florida CNA or HHA license?",
            "answer_text": "Yes — I've held my Florida CNA license since 2021, it's current and in good standing.",
            "knockout": true,
            "knockout_passed": true
          },
          {
            "question": "Are you able to work in clients' homes in the Tampa area, including weekend shifts?",
            "answer_text": "Yes, I'm available weekends and have reliable transportation.",
            "knockout": true,
            "knockout_passed": true
          },
          {
            "question": "Tell me about your most recent caregiving role.",
            "answer_text": "I spent the last three years with a private-duty agency in Brandon, mostly long-term dementia-care clients.",
            "knockout": false,
            "knockout_passed": null
          }
        ],
        "summary": "Maria holds an active Florida CNA license (since 2021), is available for weekend in-home shifts in the Tampa area, and has three years of recent private-duty dementia-care experience. She passed both knockout questions and was engaged and clear throughout the call.",
        "signals": {
          "resume_fit": {
            "rating": "strong",
            "rationale": "Three years of private-duty dementia care closely matches the in-home caregiver role requirements."
          },
          "employment_stability": {
            "rating": "strong",
            "rationale": "Two employers over five years with no unexplained gaps."
          }
        }
      }
    }
  }
}

Sends a signed ping event to the endpoint (works for both organization-scoped and partner-level endpoints — whk_ IDs are unique across your partner account). Use it to verify your signature handling end to end.

Authentication

AuthorizationBearer

Partner API key sent as Authorization: Bearer cfk_.... Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

Partner API key sent as `Authorization: Bearer cfk_...`. Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

Path parameters

whk_idstringRequired

Webhook endpoint ID (whk_...).

Response

Ping event queued for delivery; returns the event envelope that will be sent.

idstringOptional

Event ID (evt_...).

typeenumOptional

Webhook/event-log event type.

createddatetimeOptional

When the event occurred.

org_idstringOptional

Organization the event belongs to.

external_refstring or nullOptional

The related candidate’s external_ref, echoed on every event for correlation; null for ping.

dataobjectOptional

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

$	curl -X POST https://api.confirm.global/partner/v1/webhooks/whk_1GfD7cBnZy/test \
>	-H "Authorization: Bearer <token>"

Authentication

Path parameters

Headers

Response

Errors