Jobiflow LogoAPI Docs
ApiWebhooks

Test a webhook

Sends a test `ping` event to the registered URL and returns the response status and body from your endpoint. Useful for verifying connectivity and signature verification before going live. Requires scope: `webhooks:manage`

POST
/public/v1/webhooks/{id}/test

Sends a test ping event to the registered URL and returns the response status and body from your endpoint. Useful for verifying connectivity and signature verification before going live.

Requires scope: webhooks:manage

Authorization

ApiKeyAuth
X-API-Key<token>

API key issued by Jobiflow. Pass it in the X-API-Key request header.

Create keys via the company dashboard (Settings → API Keys) or via POST /settings/api-keys.

In: header

Path Parameters

id*string

UUID of the webhook subscription to test.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/public/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/test"
{
  "status": 200,
  "body": "OK"
}
{
  "status": 401,
  "error": "UNAUTHORIZED",
  "message": "Invalid or missing API key",
  "timestamp": "2026-05-17T12:00:00Z",
  "path": "/public/v1/job-listings"
}
{
  "status": 403,
  "error": "FORBIDDEN",
  "message": "Scope 'jobs:write' is required",
  "timestamp": "2026-05-17T12:00:00Z",
  "path": "/public/v1/job-listings"
}
{
  "status": 404,
  "error": "NOT_FOUND",
  "message": "Job listing not found",
  "timestamp": "2026-05-17T12:00:00Z",
  "path": "/public/v1/job-listings/00000000-0000-0000-0000-000000000000"
}