Webhook
Configure task notifications in Console. Each account can configure one HTTPS callback URL.
Configure a callback URL
- Sign in to Platform and open API management → Webhook.
- Set a name, HTTPS callback URL and success / failure events. Save and enable the configuration.
- Send a test event and inspect delivery history. Test events do not create generation tasks or deduct generation credits.
Receive and reconcile
- Hi3D sends a POST notification to the account URL when a task succeeds or fails.
- Reconcile the original task using the notification’s
task_id. Avoid processing the same event more than once. - Notifications do not replace query endpoints. Queries still reconcile state and retrieve valid download URLs; see Async tasks & results.
- Use the published contract for payloads, field types, signature verification and acknowledgment.
Delivery policy
Each event is delivered up to three times, including the initial attempt.
- After the first failure, the second attempt waits 10 seconds.
- If the second attempt fails, the third attempt waits 30 seconds.
- Retries stop after a successful delivery.
If you still do not receive a notification, query the task using the original task_id.
Delivery history includes the event ID, task ID, event, delivery time, delivery status and HTTP status.
Migrate legacy requests
For an existing integration, remove callback_url from task creation requests and enable the account-level Webhook in Console.
Supported endpoints
Notifications are available for Image to 3D, Image to Relief, Image to Embroidery, Texturing, Model Splitting and Multicolor tasks.