Webhook Setup

# Webhook Setup

Webhooks allow your application to receive real-time notifications when events occur, such as task completion or subscription changes.

## Creating a Webhook Endpoint

1. Go to Dashboard > Developer > Webhooks

2. Click Create Webhook

3. Enter:

- Endpoint URL: Your server's HTTPS URL to receive events

- Description: A label for this webhook

- Events: Select which events to subscribe to

4. Click Save

## Supported Events

| Event | Description |

|-------|-------------|

| task.completed | A background removal task finished successfully |

| task.failed | A task failed during processing |

| subscription.updated | Subscription plan changed |

| credits.updated | Credit balance changed |

| referral.reward | Referral reward credited |

## Webhook Payload

Events are sent as POST requests with JSON body:

{
  "event": "task.completed",
  "timestamp": "2026-01-15T10:30:00Z",
  "data": {
    "task_id": "uuid-here",
    "status": "succeeded"
  }
}

## Security

- Webhooks are signed with a secret key for verification

- Check the X-EaseBG-Signature header to verify authenticity

- Respond with HTTP 200 within 10 seconds

## Retries

- Failed deliveries are retried up to 3 times

- Retry intervals: 1min, 5min, 30min