Async body params #

For async render methods, one property is required compared to sync render methods, it's the webhook property. This must be added in the doppio property and it looks like this in the request body:

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

This property is usefull when you don't want to wait for the result. Your application can take care of other things and will be notified when the render is completed.

You only need to define an URL to receive the data and the response will be sent to that endpoint once the request is complete. Different HTTP methods can be used (POST, PUT...) and the response format is JSON.

A schema explaining how a webhook works is available in the page A full ASYNC workflow. This page explains how to build an async request step by step.

webhook #

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

Property details: #