> For the complete documentation index, see [llms.txt](https://docs.gepettoapp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gepettoapp.com/webhooks.md).

# 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:

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.gepettoapp.com/webhooks.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
