docAppearance
Render screenshot asynchronously
An async render request responds immediately that it understood your request, and will call you back on your webhook once the render is finished. A screenshot request renders an image.
Route
Method: POST
Route: api.doppio.sh/v1/render/screenshot/async
Examples
Request
Response
json
{
"requestId": "doppioreq_640d0598-0413-4385-8e4a-0ee43d531609",
"jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Webhook
json
{
"doppioRequestId": "doppioreq_640d0598-0413-4385-8e4a-0ee43d531609",
"renderStatus": "SUCCESS",
"documentUrl": "https://tmp.doppio.sh/doppioreq_640d0598-0413-4385-8e4a-0ee43d531609-1661856673637.webp",
"isAsync": true,
"isCustomBucket": false
}
Body
- Common body params
doppio,pageandlaunch: see here.
- Screenshot body params
page.screenshot: see here.
- Async body param
doppio.webhook: see here.
Response
To get a list of all possible response codes, see here
If everything goes well, Doppio will respond with the following payload:
| Property name | Type | Description |
|---|---|---|
requestId | string | Request identifier. Used to link your request to the webhook request |
jobId | string | Render job identifier. Save it in case you need to contact us about your request. |
Webhook
Once render is finished, Doppio will call the provided webhoook endpoint with the following payload :
| Property name | Type | Description |
|---|---|---|
doppioRequestId | string | Request identifier. |
renderStatus | string | Rendering status of your document. Can be either SUCCESSor ERROR |
documentUrl | string | URL to access your rendered document |
isAsync | boolean | If the request is async. Will always be truefor this request method |
isCustomBucket | boolean | If the document is hosted on your own S3 bucket or temporarily on our own. |