Job Status Lifecycle
Status | Description |
---|---|
queued | Job is waiting to be picked up by render engine |
render:dorender | Currently being processed |
finished | Successfully rendered; outputUrl available |
error | Encountered an error (see error field) |
Webhook Notifications (Recommended)
Instead of polling, you can configure a webhook in your job payload:POST
to the specified URL with a job payload.
Make sure your webhook endpoint is idempotent and returns a 200 OK response.
Webhook Retry Logic
If your server is temporarily unavailable, Nexrender Cloud will retry delivery up to 3 times with exponential backoff. To maximize reliability:- Respond with
200 OK
immediately (even if processing async) - Avoid timeouts — webhook POSTs should complete in under 2 seconds
- Log and audit webhook deliveries
Summary
- Use
GET /jobs/:id
to poll job state manually - Use
webhook.url
to receive async status notifications - Ensure your webhook endpoints are reliable and secure
API Reference
Authorizations
Bearer token authentication using API tokens for team-based access control.
You can generate your own API token at: https://app.nexrender.com/team/settings
Path Parameters
Unique job identifier
Response
Successfully retrieved job details
Render job with current status, progress, and detailed statistics
Unique job identifier used for tracking and API operations
Reference to the template used for this job (null if template was not used)
Current job status (queued, render:dorender, finished, error, etc.)
Render progress as a percentage (0.0 to 100.0)
Detailed timing and metadata statistics for the job
URL to the rendered content