🔑 API & Developer

Setting up webhooks

2 min read ·

Webhooks let you receive notifications when conversions complete, instead of polling the API. If you use Zapier, Make or n8n, those connect over the same webhooks without any code.

Setup

  1. Go to your Webhooks dashboard.
  2. Click “Add Webhook URL”.
  3. Enter your endpoint URL (must be HTTPS).
  4. Copy the signing secret — you’ll need it to verify payloads.

Webhook events

Event When
conversion.completed A conversion finished successfully
conversion.failed A conversion encountered an error
job.completed A batch job (all files) completed
job.failed A batch job failed

Verifying signatures

Every webhook request includes an X-Webhook-Signature header containing an HMAC-SHA256 signature. Verify it to ensure the request came from KoalaPic:

import hmac
import hashlib

def verify_webhook(payload: bytes, signature: str, secret: str) -> bool:
    expected = hmac.new(
        secret.encode(), payload, hashlib.sha256
    ).hexdigest()
    return hmac.compare_digest(signature, expected)

Retry policy

Failed deliveries (non-2xx responses) are retried up to 3 times with increasing delays: immediately, after 30 seconds, and after 2 minutes. After 3 failures, the delivery is marked as failed and visible in your dashboard.

Per-request webhooks

You can also set a webhook URL per conversion request by including webhook_url in your API call. This overrides your default webhook for that specific conversion. The payload for every event is documented in the API reference.

Was this helpful?

Thanks for your feedback!

Looking for something else?

Enviar Comentarios

¡Gracias! Te responderemos pronto.

Instalar KoalaPic

Agrégalo a tu pantalla de inicio para acceso rápido

Preferencias de Cookies y Almacenamiento

Usamos cookies y almacenamiento local para mejorar tu experiencia. El almacenamiento esencial siempre está activo para el funcionamiento básico. Más información

Esencial

Protección CSRF, modo oscuro, seguimiento de errores. Siempre activo.

Funcional

Presets de conversión, preferencias de interfaz, estado de instalación de la PWA.

Análisis

Estadísticas de uso anónimas para mejorar el servicio.