Render PDF asynchronously

An async render request responds immediately to confirm that the request has been accepted, then calls your webhook once the render is complete. In this case, the output is a PDF.

An additional doppio.webhook parameter is required in the request body.

Route

Method: POST

Route: api.doppio.sh/v1/render/pdf/async

Examples

Request

With goToWith setContent

Response

{
  "requestId": "doppioreq_640d0598-0413-4385-8e4a-0ee43d531609",
  "jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Webhook

{
  "doppioRequestId": "doppioreq_640d0598-0413-4385-8e4a-0ee43d531609",
  "renderStatus": "SUCCESS",
  "documentUrl": "https://tmp.doppio.sh/doppioreq_640d0598-0413-4385-8e4a-0ee43d531609-1661856673637.pdf",
  "isAsync": true,
  "isCustomBucket": false
}

Body

• Common body parameters doppio, page, and launch: see here.

• PDF body parameters page.pdf: see here.

• Async body parameter doppio.webhook: see here.

Response

For the full list of possible response codes, see What to expect from us.

If the request succeeds, Doppio responds with the following payload:

Property name	Type	Description
requestId	string	Unique identifier for the request. Used to associate it with the webhook call.
jobId	string	Identifier for the render job. Save it in case you need to contact us about your request.

Webhook

Once rendering is complete, Doppio calls the webhook endpoint you provided with the following payload:

Property name	Type	Description
doppioRequestId	string	Unique identifier for the request.
renderStatus	string	Rendering status for your document. Either SUCCESS or ERROR.
documentUrl	string	URL where you can access the rendered document.
isAsync	boolean	Whether the request is asynchronous. For this render method, the value is always true.
isCustomBucket	boolean	Whether the document is stored in your own S3 bucket or temporarily in ours.