Webhooks

Webhook processor status.

Campaign dialler health

GET /webhooks/campaign/status

Health check for the platform’s campaign dialler: reports whether the background process that places campaign calls is running on the server that answered. Not specific to your organisation.

Scope: webhooks:read

Example request

curl -X GET "https://api.foan.ai/api/v1/webhooks/campaign/status" \
  -H "Authorization: Bearer $FOAN_API_KEY"

Response 200

{
  "success": true,
  "status": "RUNNING",
  "message": "Campaign queue processor is running",
  "nextRunAt": "2026-09-25T10:05:00.000Z"
}

Errors

Code	When
401	Missing, invalid or revoked API key
403	Key lacks the webhooks:read scope
429	Rate limited: 100 requests per minute per IP address (default)
500	Unexpected failure