Completion webhooks and the API plan

How it works

Add callback_url (a public https address) when you create a report or check. When it finishes, PollyX sends a POST to that address:

• on success: the status, the score, the id and its poll_url;
• on failure: "status": "failed" and the reason, generation_failed or insufficient_data.

The message is a notification only. It carries no report content and no signature: fetch the full result from the poll_url with your API key, which is also how you confirm the call is genuine.

The API plan

Completion webhooks need the API plan (€114 a month). Without it, a request that includes callback_url is refused before any credit is used. The plan also includes:

• 6 credits every month, which never expire;
• 120 creations an hour per key instead of 30;
• queue priority, so your reports and checks start ahead of others.

API keys and everything else in the API work without the plan.