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

# Webhooks

General use case is when you do not want (or have possibility) to write the code that waits for the processing result. In that situation deep image will send the processing result information directly to user defined url.

Deep image provides webhooks support for the end of image processing event.

There two types of webhooks:

* set by Deep Image staff at user's account
* specified in the request

You can specify webhook in your processing request where the data with completed job will be sent:

```json
{
    "url": "https://deep-image.ai/api-example.png",
    "width": 1000,
    "height": 1000,
    "webhooks": {
        "complete": "https://YOUR-WEBHOOK"
    }
}
```

So, when job is completed, address "YOUR-WEBHOOK" will receive that data:

```json
{
  "job": "ce0e7624-634e-11ee-a699-0242ac14000b",
  "data": YOUR_REQUEST,
  "result_url": "https://localhost:8073/images/2023-10-05/1f48bcdb-0117-49aa-b9e3-c5df10680642.png",
  "results": null
}
```

If you cannot specify webhook in your request, please write a message to <support@deep-image.ai> and user's account webhook will be set.


---

# 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://documentation.deep-image.ai/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.