Webhooks

Webhooks are the recommended way to receive analysis results. Instead of you repeatedly asking us if the job is done (polling), we will tell you the moment it is.

How It Works

1. When you submit a job, you provide a publicly accessible webhook_url.
2. Once the analysis is complete (successfully or with an error), our server will send an HTTP POST request to that URL.
3. The body of the request will be a JSON object containing the analysis result.

Webhook Payload

The payload sent to your webhook URL will have the following structure.

On Success

{
    "job_id": "687370cfb0e401e92a4336ed",
    "status": "completed",
    "data": { /* The full Report Object */ }
}
            

On Failure

{
    "job_id": "687370cfb0e401e92a4336ed",
    "status": "failed",
    "error": "A user-friendly description of the error."
}
            

Best Practices

Your webhook endpoint should respond with a 2xx HTTP status code (e.g., 200 OK) as quickly as possible to acknowledge receipt. Do not perform heavy processing before responding. Store the payload and process it asynchronously.