Alfa

Webhooks

Send a test event

POST/v1/integration/webhook-endpoint/test

Sends a signed `webhook.test` event with a sample candidate to your endpoint now, and reports how it answered. Requires an API key with the `webhooks:manage` scope.

Requires an Alfa API key as a bearer token. How API keys work

Headers

  • Alfa-Company-Idstring

    The Company ID of the company to act for. Required with a platform key, and that company must have authorized your platform; a company key acts for its own company and can leave it out.

Response body

  • eventIdstringrequired

    The id of the `webhook.test` event sent.

  • deliveredbooleanrequired

    Whether your endpoint answered with a 2xx status.

  • statusCodeinteger | nullrequired

    The status your endpoint answered with; null when it could not be reached.

  • durationMsintegerrequired

    How long the request took.

  • errorstring | nullrequired

    Why the delivery failed, when it did.

Responses

  • 200Success.
  • 400The request is malformed: invalid JSON, an unexpected body or an unknown query parameter. Problem details
  • 401The bearer token is missing, expired or invalid. Problem details
  • 403The caller may not perform this operation, or has no active organisation. Problem details
  • 404The resource does not exist or is not visible to the caller. Problem details
  • 422The request failed validation; `errors` lists each invalid field. Problem details
  • 429Too many requests, or the AI service is busy. Retry after a short wait. Problem details
  • 500An unexpected error. Quote the `correlationId` to support. Problem details