RocketMap can send map information such as Pokémon spawns, gym details, raid appearances and pokestop lures to other applications through webhooks.

Every time a webhook-enabled event occurs (for example a new Pokémon appearing) a web request will be sent to a provided URL containing information about that event.

• What Do Webhooks Do?
• Setting Up a Webhook
  • Setting webhook urls
    • Using the command line
    • Using a config file
  • Setting webhook types
    • Using the command line
    • Using a config file
  • Filtering Pokémon
    • Whitelisting Pokémon
    • Blacklisting Pokémon
• Webhook Types
  • pokemon
  • pokestop
  • lure
  • gym
  • gym-info
  • egg
  • raid
  • tth
  • captcha
• PokeAlarm
• RocketMap Public Webhook

Webhooks allow developers to send data from RocketMap to other applications.

A simple example would be an application that receives Pokémon spawn events, checks if the Pokémon that's appeared is a Dragonite, and if so plays an alarm sound.

To start sending data to a webhook:

1. set a webhook url (or list of webhook urls) to send data to
2. set the webhook types to be received
3. (optional) set up a whitelist or blacklist

If no webhook types are set, no webhook data will be sent.

Add -wh http://YOUR_WEBHOOK_URL to your existing command line.

To send data to multiple URLs, add a new -wh ... string for each URL, for example:

-wh http://YOUR_FIRST_WEBHOOK_URL -wh http://YOUR_SECOND_WEBHOOK_URL

Add a new line to your config file:

webhook: http://YOUR_WEBHOOK_URL

To send data to multiple URLs, use an array:

webhook: [ http://YOUR_FIRST_WEBHOOK_URL, http://YOUR_SECOND_WEBHOOK_URL ]

Add --wh-types WEBHOOK_TYPE to your existing command line.

To set multiple webhook types, add a new --wh-types ... string for each URL, for example:

--wh-types pokemon --wh-types raid

Add a new line to your config file:

wh-types: WEBHOOK_TYPE

To set multiple webhook types, use an array:

wh-types: [ pokemon, raid ]

To limit the Pokémon that get sent to webhooks you can:

• whitelist specific Pokémon IDs, or
• blacklist specific Pokémon IDs

If you use a whitelist you cannot also use a blacklist (and vice-versa).

You can whitelist/blacklist Pokémon IDs using either a list or a file. You can use either a list or a file, but not both.

If you want to send webhook data for specific Pokémon (and no other Pokémon) you can use a Pokémon whitelist.

Using a string

You can a string of Pokémon IDs to whitelist using:

webhook-whitelist: [ POKEMON_ID_1, POKEMON_ID_2, POKEMON_ID_3 ]

Using a file

You can set a whitelist file using:

webhook-whitelist-file: WHITELIST_FILE

Note: each Pokémon ID must be on a new line.

Example

Whitelisting Dratini, Dragonair, Dragonite, Larvitar, Pupitar and Tyranitar using a whitelist array:

config.ini:

webhook-whitelist: [ 147, 148, 149, 246, 247, 248 ]

If you want to exclude specific Pokémon from being set to webhooks you can use a Pokémon blacklist.

Using a string

You can a string of Pokémon IDs to blacklist using:

webhook-blacklist: [ POKEMON_ID_1, POKEMON_ID_2, POKEMON_ID_3 ]

Using a file

You can set a blacklist file using:

webhook-blacklist-file: BLACKLIST_FILE

Note: each Pokémon ID must be on a new line.

Example

Blacklisting Pidgey, Spearow, Caterpie and Weedle using a blacklist file:

config.ini:

webhook-blacklist-file: pokemon-blacklist.txt

pokemon-blacklist.txt:

10
13
16
21

Data is sent to webhooks as a JSON object containing an array of webhook events.

Each webhook event has the structure:

{
  "type":    EVENT_TYPE,
  "message": EVENT_DATA
}

For example:

[
  {
    "type":    "pokemon",
    "message": { ... }
  },
  {
    "type":    "pokemon",
    "message": { ... }
  },
  {
    "type":    "pokemon",
    "message": { ... }
  },
  {
    "type":    "gym",
    "message": { ... }
  }
]

RocketMap currently provides the following webhook types: pokemon, pokestop, lure, gym, gym-info, egg, raid, tth, captcha. Please note that as RocketMap evolves more webhook types may be added.

If you are a developer please feel free to contribute new webhook types through the usual RocketMap development process.

The sections below outline the different webhook types and the data that gets sent for each event.

A pokemon event is sent every time RocketMap detects that a Pokémon has spawned.

1. Pokémon genders are represented by the values:

2. These fields will be empty unless the Pokémon has been encountered.

A pokestop event is sent whenever RocketMap scans a pokestop.

A lure event is sent whenever RocketMap scans a pokestop if that pokestop has been lured.

Important: while the webhook type name for lure events is lure, when this data is sent to a webhook the type field will be pokestop.

Note: if you add lure events to your wh_types you will receive them even if you have not enabled pokestop events.

Lure events contain the same fields as pokestop events (described above).

A gym event is sent whenever RocketMap scans a gym.

1. The teams are represented by the values:

2. Gym changes include: Pokémon being added, Pokémon being knocked out, gym control changing etc.
3. If there is no raid at the gym this value will be 0.

A gym-info event is sent whenever RocketMap fetches a gym's details.

Important: while the webhook type name for gym-info events is gym-info, when this data is sent to a webhook the type field will be gym_details.

Gym Pokémon:

An egg event is sent whenever RocketMap detects that an egg has appeared at a gym.

Important: while the webhook type name for egg events is egg, when this data is sent to a webhook the type field will be raid.

Note: egg events use the same event type and fields as raid events, but the Pokémon-specific fields such as pokemon_id will be null.

A raid event is sent whenever RocketMap detects that a raid has started at a gym.

Note: raid events use the same event type and fields as egg events, but the Pokémon-specific fields such as pokemon_id will be populated.

1. The teams are represented by the values:

A tth event is sent whenever a scan instance's TTH completion status changes by more than 1%.

Important: while the webhook type name for tth events is tth, when this data is sent to a webhook the type field will be scheduler.

Note: at present only the speed-scan scheduler sends tth events.

A captcha event is sent whenever a scan worker encounters a captcha.

1. Possible captcha statuses:

PokeAlarm is an application which can be used to send alerts for various events.

PokeAlarm receives data from RocketMap through webhooks, processes and filters the data, and can then send event-specific alerts through messaging services such as Twitter and Discord.

A full list of the events PokeAlarm can provide alerts for, as well as the messaging services that can be used, can be found in the PokeAlarm wiki.

RocketMap is collecting data for an upcoming project. If you would like to help our efforts please fill out this form. You will then receive an email with a webhook url which you can add to your list of webhooks.