> ## Documentation Index
> Fetch the complete documentation index at: https://www.krea.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks

> Configure webhooks para receber eventos de conclusão de tarefas em tempo real, reduzir o polling e construir fluxos assíncronos fiáveis na sua aplicação.

## Visão geral

Em vez de consultar `GET /jobs/{id}` repetidamente, pode fornecer um URL de webhook para receber um pedido POST quando a sua tarefa terminar. Isto é mais eficiente e reduz chamadas de API desnecessárias.

## Utilizar webhooks

Adicione o cabeçalho `X-Webhook-URL` a qualquer pedido de geração. Quando a tarefa chegar a um estado terminal (completed, failed ou cancelled), a API enviará um pedido POST para o seu URL com os dados completos da tarefa.

<CodeGroup>
  ```javascript Node.js theme={null}
  // npm install @krea-ai/sdk
  import { Krea } from "@krea-ai/sdk";

  const krea = new Krea({ apiKey: process.env.KREA_API_KEY });

  const job = await krea.image(
    "bfl/flux-1-dev",
    {
      prompt: "a serene mountain landscape at sunset",
      width: 1024,
      height: 576
    },
    { webhookUrl: "https://your-server.com/webhook" }
  );

  console.log(`Job ID: ${job.job_id}`);
  // Your webhook will receive the results when complete
  ```

  ```bash cURL theme={null}
  curl -X POST https://api.krea.ai/generate/image/bfl/flux-1-dev \
    -H "Authorization: Bearer YOUR_API_TOKEN" \
    -H "Content-Type: application/json" \
    -H "X-Webhook-URL: https://your-server.com/webhook" \
    -d '{
      "prompt": "a serene mountain landscape at sunset",
      "width": 1024,
      "height": 576
    }'
  ```

  ```python Python theme={null}
  import requests

  API_BASE = "https://api.krea.ai"
  API_TOKEN = "your-token-secret"

  response = requests.post(
      f"{API_BASE}/generate/image/bfl/flux-1-dev",
      headers={
          "Authorization": f"Bearer {API_TOKEN}",
          "Content-Type": "application/json",
          "X-Webhook-URL": "https://your-server.com/webhook"
      },
      json={
          "prompt": "a serene mountain landscape at sunset",
          "width": 1024,
          "height": 576
      }
  )

  job = response.json()
  print(f"Job ID: {job['job_id']}")
  # Your webhook will receive the results when complete
  ```

  ```go Go theme={null}
  package main

  import (
      "bytes"
      "encoding/json"
      "fmt"
      "net/http"
  )

  func main() {
      apiBase := "https://api.krea.ai"
      apiToken := "your-token-secret"

      payload := map[string]interface{}{
          "prompt": "a serene mountain landscape at sunset",
          "width":  1024,
          "height": 576,
      }

      jsonData, _ := json.Marshal(payload)
      req, _ := http.NewRequest("POST", apiBase+"/generate/image/bfl/flux-1-dev", bytes.NewBuffer(jsonData))
      req.Header.Set("Authorization", "Bearer "+apiToken)
      req.Header.Set("Content-Type", "application/json")
      req.Header.Set("X-Webhook-URL", "https://your-server.com/webhook")

      client := &http.Client{}
      resp, _ := client.Do(req)
      defer resp.Body.Close()

      var job map[string]interface{}
      json.NewDecoder(resp.Body).Decode(&job)
      fmt.Printf("Job ID: %s\n", job["job_id"])
      // Your webhook will receive the results when complete
  }
  ```
</CodeGroup>

## Payload do webhook

Quando a tarefa termina, o seu URL de webhook recebe um pedido POST com os dados da tarefa:

```json theme={null}
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "created_at": "2025-01-15T10:30:00.000Z",
  "completed_at": "2025-01-15T10:30:05.000Z",
  "result": {
    "urls": ["https://..."]
  }
}
```

## Boas práticas

<Check>
  **Responda rapidamente** — devolva um código de estado 2xx sem demora. Processe os dados do webhook de forma assíncrona, se necessário.
</Check>

<Warning>
  **Valide o payload** — verifique se o `job_id` corresponde a uma tarefa que iniciou antes de processar os resultados.
</Warning>

* Utilize endpoints HTTPS por segurança
* Implemente idempotência para o caso de entregas duplicadas
* Registe a receção de webhooks para depuração

## Webhooks vs polling

| Abordagem    | Prós                                                 | Contras                              |
| ------------ | ---------------------------------------------------- | ------------------------------------ |
| **Webhooks** | Notificações em tempo real, menos chamadas de API    | Requer um endpoint público           |
| **Polling**  | Funciona em qualquer lado, não é necessário servidor | Mais chamadas de API, ligeiro atraso |

Use webhooks quando tiver um servidor que possa receber pedidos HTTP. Use polling em aplicações do lado do cliente ou quando não puder expor um endpoint público.

## Próximos passos

<CardGroup cols={2}>
  <Card title="Ciclo de vida das tarefas" icon="cube" href="/developers/job-lifecycle">
    Saiba mais sobre os estados das tarefas e o polling de estado
  </Card>

  <Card title="Exemplos de código" icon="code" href="/developers/examples/text-to-image">
    Veja exemplos completos com tratamento de webhooks
  </Card>
</CardGroup>