ASYNC_TASK_RESULT
event on your webhook endpoint.
Get Started
Enable Webhook in Request
For the asynchronous V3 APIs that support webhooks, the webhook parameters are provided in theextra.webhook
field. (For more details, please refer to the individual documentation pages for each API.) For example:
ASYNC_TASK_RESULT
event to your webhook endpoint. For example:
payload
fields is exactly the same as the response from the Task Result API.
Use Test Mode to Test Your Integration
You can test your integration without making actual API calls by enablingTest Mode
. For example:
Retry Policy
Novita AI will retry up to five times if it fails to send the event to your webhook endpoint. This includes the following situations:- The request to your endpoint times out (currently set to 5 seconds).
- Your endpoint returns a non-2xx status code.
Best Practices
- Your webhook endpoint must quickly return a successful status code 2xx before executing any complex logic that could cause a timeout.
- After receiving a webhook event, filter out any events other than
ASYNC_TASK_RESULT
to continue with your logic. - Before releasing features that rely on the webhook event, use
Test Mode
to thoroughly test your logic. - Use HTTPS for your webhook endpoint.