---
title: "Webhook"
description: "Get a POST request when a PixAI API task starts, completes, is cancelled or fails, through webhooks on your profile or a per-request callbackUrl."
canonical: "https://platform.pixai.art/en/docs/references/webhook"
last-updated: "2026-10-17"
---

# Webhook

Get a POST request when a PixAI API task starts, completes, is cancelled or fails, through webhooks on your profile or a per-request callbackUrl.



Developers can configure one or more webhooks to receive notifications about the status of tasks.

When a task is started, completed, canceled or failed, the platform will send a POST request to the specified URL.

You can configure it on [your profile page](https://pixai.art/profile/edit/api).

If you are using `callbackUrl` in the `REST` API, the body format follows this format:

```json
{
    "action": "task_running",
    "data": {
        "id": "1829312678046282149",
        "status": "running",
        "createdAt": "2024-12-27T09:25:46.436Z",
        "updatedAt": "2024-12-27T09:26:01.912Z",
        "outputs": {
            "mediaIds": [],
            "mediaUrls": []
        }
    }
}
```