Webhooks

When using the Gepetto API to generate renderings with /redesign, /furnish and /upscale endpoints, you have the option to use a webhook parameter to avoid waiting for a synchronous server reply.

To leverage this functionality, simply pass the webhook parameter in the body followed by the URL where you want to receive the rendering results.

When the rendering process is complete, our server will send a POST request to the provided URL, allowing you to receive the results asynchronously. This means you can proceed with other tasks and retrieve the rendering once it’s ready, making your workflow more efficient and seamless. It’s crucial to ensure that the provided webhook URL is correct and capable of receiving POST requests to avoid any disruptions or loss of data.

Here is an example of result our server will send to you URL:

{  
    "id": "xxxxxxxxxxxxxxxxxxx",  
    "output": "<Image URL>"
}

Last updated