Async body params

Compared with sync render methods, async render methods require one additional property: webhook. It must be added inside the doppio object and looks like this in the request body:

{
  "doppio": {
    "webhook": {
      "url": "https://your-system-url.com/callback",
      "method": "POST"
    }
}

This property is useful when you do not want to wait for the result in the original request. Your application can continue its work and will be notified when the render is complete.

You only need to define a URL that can receive the payload. Once the request is complete, Doppio sends the response to that endpoint. Different HTTP methods can be used (POST, PUT, and so on), and the payload format is JSON.

If you want a step-by-step explanation of the webhook flow, see A full ASYNC workflow.

webhook

{
  "webhook": {
    "url": "https://your-system-url.com/callback",
    "method": "POST",
    "headers": {
      "Content-type": "application/json",
      ...
    }
  }
}

Property details:

Property name	Type	Description
url	string	URL that will receive the webhook request.
method	string	HTTP method used to send the webhook request (GET, POST, PUT, PATCH, DELETE).
headers	Record<string, string>	Headers to add to the webhook request. optional