PixAI Platform
Extras

Webhook

Webhook for async notification

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.

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

{
    "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": []
        }
    }
}