{
"url": "<string>",
"receiveType": "URL",
"method": "POST",
"headers": {},
"metadata": {}
}Sync/Async options
Webhook options
Webhook options that are available for the async endpoints.
For the
/async endpoints the webhook property comes into play.
This feature proves valuable when waiting for the result isn’t necessary.
Your application can attend to other tasks, and a notification will be triggered upon completion of the render.
All you need to do is specify a URL to receive the data,
and the response will automatically be directed to that endpoint once the request concludes.
Various HTTP methods like POST or PUT can be used, you can also choose to receive the document in base64 or an temporary url to download the file.
See also
Securing your webhook on how
to improve your webhooks security and Webhook event for the payload
that will be sent to your webhook.
Available on endpoints:
| Endpoint | Type |
|---|---|
POST | async |
async | |
async |
The way this webhook wants to receive the result.
- When
URLis used an temporary URL will be provided to download the file (the file will be automatically deleted after 1 hour). - When
base64is used make sure your webhook can receive the size of the file!
Available options:
base64, URL Example:
"URL"
Was this page helpful?