> For the complete documentation index, see [llms.txt](https://unbox-1.gitbook.io/unbox/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://unbox-1.gitbook.io/unbox/webhooks.md).

# Webhooks

### How It Works

The webhook posts to the **Discord webhook URL** you configure.

You can customize:

* Display name and avatar of the webhook bot.
* Title, description, footer, and color of the embed.
* Whether to show pull **rates**.

Placeholders such as `{player}`, `{pokemon}`, `{pack_name}`, `{form}`, etc. are replaced automatically at runtime.

```
#turn webhooks on or off
enabled: true

# Your Discord webhook URL (get this from your Discord channel > Integrations > Webhooks)
url: "https://discord.com/api/webhooks/{YOUR_URL_HERE}"

# The "username" that shows as the webhook sender in Discord
username: "Unbox"

# The avatar image to show in Discord (leave blank for none, or paste an image URL)
avatar_url: ""

# Controls whether drop chances are displayed in the embed
show_rate:
  # true = show rare % chances when below threshold
  enabled: true
  # Only show chances if % chance is below this number
  below_percent: 1.0

# Template for how the embed looks
template:
  # Embed title. Placeholders are replaced automatically.
  # {player} = the player who opened the pack
  # {pokemon} = the species they pulled
  title: "🎁 UNBOX • {player} » **{pokemon}**"

  # Main description block of the embed.
  # Placeholders: {pack_name}, {form}, {palette}, {level}, {nature}
  # (Rate % is added automatically by code if below threshold.)
  description: |
    **Pack:** {pack_name}
    ─────────────────────
    `Form` {form}   `Palette` {palette}   `Lv` {level}   `Nature` {nature}

  # Text in the footer of the embed (small text at the bottom)
  footer: "Unbox • Pixelmon rewards"

  # Accent color of the embed border (hex code or int).
  color: "#F59E0B"   # Amber
```

## Placeholders

These can be used in **title**, **description**, and **footer**:

* `{player}` → Player’s name
* `{pack_id}` → Internal pack ID
* `{pack_name}` → Pack display name
* `{pokemon}` → Pokémon species name
* `{form}` → Form name (blank if none)
* `{palette}` → Palette name (blank if base)
* `{level}` → Level (blank if none)
* `{nature}` → Nature name (blank if none)
* `{chance_percent}` → example: “0.37%”
* `{chance_1_in}` → example: “1 in 270”


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://unbox-1.gitbook.io/unbox/webhooks.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.