Error Responses

All error responses returned by the API use a consistent structure:

{
  "error": "string",
  "message": "string",
  "statusCode": number
}

The error field contains a short identifier for the error category. The message field provides a human-readable explanation. The statusCode field repeats the HTTP status code of the response.

Common Error Codes

The OpenAPI specification documents the following error scenarios for specific endpoints.

Webhook Endpoint

POST /webhooks may return:

• 400: Invalid signature or payload. This occurs when HMAC signature validation fails or the request body does not conform to an expected GitHub webhook event.
• 500: Internal server error. This is returned for unexpected failures during request processing.

Successful webhook ingestion returns 200 or 204.

Job Endpoint

GET /jobs/{id} may return:

• 404: Job not found. This occurs when the identifier in the path does not match any existing job record.

GET /jobs and GET /health do not document specific error responses beyond the general error shape.

Retry Guidance

The source documentation does not define retry policies, backoff intervals, or idempotency requirements. Webhook clients should treat any response other than 200 or 204 as a failure to acknowledge and may re-deliver according to GitHub's own retry behavior for webhooks.