# Bunny Stream Webhooks

## When to Use This Skill

* Setting up Bunny Stream webhook handlers
* How do I verify Bunny Stream webhook signatures?
* Debugging `X-BunnyStream-Signature` verification failures
* Handling video state changes (encoding finished, encoding failed)
* Reacting to `Status 3` (Finished), `Status 5` (Failed), captions, or title/description events

## Verification (core)

Bunny Stream signs the exact raw request body with HMAC-SHA256, keyed on your video library's Read-Only API key, and sends the digest as lowercase hex in the `X-BunnyStream-Signature` header. Verify against the unparsed raw body (do NOT re-serialize the JSON — whitespace or key-order changes break the digest) and compare timing-safe.

> This is a custom scheme, not Standard Webhooks (no `webhook-id` / `webhook-timestamp` / `webhook-signature`). It is also distinct from Bunny's general-platform webhooks (HMAC-SHA1, `x-bunny-signature`) — Stream uses SHA-256 and `X-BunnyStream-Signature`. There is no official SDK, so verify manually.

Node:

```javascript
const crypto = require('crypto');

function verifyBunnyStream(rawBody, signatureHeader, secret) {
  if (!signatureHeader) return false;
  const expected = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
  try {
    return crypto.timingSafeEqual(
      Buffer.from(signatureHeader, 'hex'),
      Buffer.from(expected, 'hex')
    );
  } catch {
    return false; // malformed hex / length mismatch
  }
}

```

Python:

```python
import hmac, hashlib

def verify_bunny_stream(raw_body: bytes, signature_header: str, secret: str) -> bool:
    if not signature_header:
        return False
    expected = hmac.new(secret.encode(), raw_body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(signature_header, expected)

```

> For complete handlers with route wiring, event dispatch, and tests, see:
> 
> * [examples/express/](https://github.com/hookdeck/webhook-skills/tree/main/skills/bunny-stream-webhooks/examples/express/)
> * [examples/nextjs/](https://github.com/hookdeck/webhook-skills/tree/main/skills/bunny-stream-webhooks/examples/nextjs/)
> * [examples/fastapi/](https://github.com/hookdeck/webhook-skills/tree/main/skills/bunny-stream-webhooks/examples/fastapi/)

## The Payload Is Thin — Fetch Back

The callback body carries only three fields:

```json
{ "VideoLibraryId": 12345, "VideoGuid": "0a1b2c3d-...", "Status": 3 }

```

There is no title, duration, or resolution in the payload. When you need full metadata, call the [Stream API](https://docs.bunny.net/reference/video_getvideo) `GET /library/{libraryId}/videos/{videoGuid}` with your (read-write) AccessKey, using `VideoGuid` from the webhook. Verify the signature before making any fetch-back call.

## Status Codes (the event type lives in `Status`)

| Status | Meaning | Common Use |
| --- | --- | --- |
| `0` | Queued | Upload accepted, awaiting processing |
| `1` | Processing | Ingest started |
| `2` | Encoding | Transcoding in progress |
| `3` | Finished | Encoding done — video ready to play |
| `4` | ResolutionFinished | A single resolution finished encoding |
| `5` | Failed | Encoding failed — alert / retry |
| `6` | PresignedUploadStarted | TUS/presigned upload began |
| `7` | PresignedUploadFinished | Presigned upload completed |
| `8` | PresignedUploadFailed | Presigned upload failed |
| `9` | CaptionsGenerated | Auto-captions ready |
| `10` | TitleOrDescriptionGenerated | AI title/description ready |

> For the full event reference, see [Bunny Stream Webhooks](https://docs.bunny.net/stream/webhooks).

## Important Headers

| Header | Description |
| --- | --- |
| `X-BunnyStream-Signature` | HMAC-SHA256 of the raw body, lowercase hex — verify this |
| `X-BunnyStream-Signature-Version` | Signature scheme version (`v1`) — unconfirmed (see note) |
| `X-BunnyStream-Signature-Algorithm` | Algorithm identifier (`hmac-sha256`) — unconfirmed (see note) |

> The `-Version` and `-Algorithm` headers were observed in a single fetch only and are unconfirmed — they may or may not be present. Do not rely on them; verify solely against `X-BunnyStream-Signature`.

## Environment Variables

```bash
# The signing secret IS your video library's Read-Only API key
BUNNY_STREAM_WEBHOOK_SECRET=your_library_read_only_api_key

```

## Local Development

```bash
# Start tunnel (no account needed)
npx hookdeck-cli listen 3000 bunny-stream --path /webhooks/bunny-stream

```

## Reference Materials

* [references/overview.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/bunny-stream-webhooks/references/overview.md) - Bunny Stream webhook concepts, Status enum, payload
* [references/setup.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/bunny-stream-webhooks/references/setup.md) - Configure the webhook URL per video library
* [references/verification.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/bunny-stream-webhooks/references/verification.md) - Signature verification details and gotchas