Scanner Setup¶

PoracleNG receives Pokemon Go data via webhooks from a scanner. Golbat is the main and recommended source. RDM is supported for setups that already use it.

MAD Not Supported

MAD scanner support has been removed in PoracleNG. If you currently use MAD, you'll need to switch to Golbat.

Golbat (recommended)¶

Golbat is the default scanner and where most webhook traffic for PoracleNG comes from. Webhooks are configured in Golbat's own config.toml, not in PoracleNG — see Golbat's example config in its repository for the full set of options (filters by types, areas, custom headers, multiple endpoints, etc.).

All you need to tell Golbat is where PoracleNG is listening:

# In Golbat's config.toml
[[webhooks]]
url = "http://<poracle-host>:3030/"

The webhook endpoint is the processor's root path / on port 3030 (or whatever you've set in PoracleNG's [processor] host/port).

Webhook types PoracleNG processes¶

Golbat can filter which webhook types it sends. PoracleNG processes these:

Type	Description
`pokemon`	All pokemon (with and without IVs)
`pokemon_iv`	Only encountered pokemon with IV/CP/level data
`pokemon_no_iv`	Only nearby pokemon without encounter data
`raid`	Raids and eggs
`quest`	Field research quests
`invasion`	Team Rocket invasions and other pokestop incidents
`pokestop`	Pokestop state — drives lures, Showcases, and invasions/incidents carried on the stop
`gym` / `gym_details`	Gym team/slot/battle changes
`weather`	In-game weather changes
`fort_update`	Fort (gym/pokestop/station) additions, removals and edits
`max_battle`	MAX Battles at Power Spots
`nest`	Nest updates

Showcases need the pokestop type

Showcase (pokestop contest) alerts are built from the showcase_* fields on the pokestop webhook — there is no separate showcase webhook type. If you filter Golbat's types, keep pokestop if you want lure or Showcase alerts.

By default Golbat sends all of these; restrict with a types = [...] filter in the [[webhooks]] entry if you want to narrow the stream. Refer to Golbat's docs for the exact syntax and any additional filters they've added.

RDM¶

If your webhook source is RDM, point its webhook configuration at the same endpoint:

http://<poracle-host>:3030/

To enable RDM-specific features on the PoracleNG side (pokestop name lookups, some quest enrichment), also configure the scanner database connection and set the type:

[database.scanner]
host = "127.0.0.1"
port = 3306
user = "scanneruser"
password = "scannerpassword"
database = "scannerdb"
type = "rdm"          # "golbat" (default) or "rdm"

Back-compat alias

Older configs set scanner_type under [database] instead. PoracleNG still reads that spelling for backward compatibility, but the canonical location is [database.scanner].type.

Verifying Webhooks¶

After configuring your scanner, verify that the processor is receiving webhooks:

# Check processor health
curl http://localhost:3030/health

# Check processor metrics for webhook counts
curl http://localhost:3030/metrics | grep webhook

You can also check logs/processor.log for incoming webhook activity.

Disabling Webhook Types¶

If you want to disable processing of specific webhook types on the PoracleNG side (regardless of what the scanner sends), use the disable_* settings in config.toml:

[general]
disable_pokemon = false
disable_raid = false
disable_invasion = false
disable_lure = false
disable_quest = false
disable_showcase = false
disable_weather = false
disable_nest = false
disable_gym = false
disable_fort_update = false
disable_max_battle = false

The pokestop webhook is split by content, so use disable_lure, disable_invasion and disable_showcase to turn off the alert types it carries individually.

disable_pokestop is deprecated

disable_pokestop is still accepted so old configs load, but it does nothing. Replace it with disable_lure, disable_invasion, disable_quest and/or disable_showcase.