The render object

A Render is what is generated when you render an image or PDF from a template.
On the next step you will learn how to create a render.

Bellow are the basic attributes of a Render.
All other attributes of the object are set by the user at the time of creation.

Attributes

id string
The unique ID for this object.

render_url string
The final, rendered render url. This will be null to begin with and populates when the render has the status completed.

created_at string
The date and time the render was created.

status string
The current status of the render; pending, completed or failed.

template string
The ID of the template used to generate the render.

webhook_url string
The webhook URL that will be called when the render is completed.

Sample Object

Here’s a sample object of a render:

{
  "id": "ce424057-6b54-41bb-afec-adc35a2b9175",
  "render_url": "https://templated-assets.s3.amazonaws.com/render/ce424057-6b54-41bb-afec-adc35a2b9175.jpg",
  "created_at": "2023-10-02T10:00:00.077Z",
  "status": "completed",
  "template": "1f1231-dasd123-fsdf12312-fds4123-asdas23",
  "webhook_url": "https://webhook-to-be-called.com/webhook"
}