Anki Beacon

AnkiWeb addon 1577021707

Sends JSON webhook events from Anki to local or remote HTTP receivers, currently note creation plus optional heartbeat, with configurable URLs and payload modes.
AI-generated summary; may contain mistakes.

sync-integration

Open on AnkiWeb GitHub Ask about alternatives

AnkiWeb

Rating
0 (πŸ‘ 0 Β· πŸ‘Ž 0)
Updated
2026-05-03
Anki versions
2.1.1~
Description language
en

Maintenance

active

  • Last update or commit was 150 days before the snapshot (2026-05-04).

Will it work on my Anki?

Version branches
Min AnkiMax AnkiUpdated
2.1.1+2026-05-03
History across monthly snapshots

Loading…

Similar addons

TRMNL Anki

Sends selected Anki note fields to TRMNL via webhooks at a configurable interval, using search queries and multiple plugin configurations.

sync-integrationservice-client

Rating 1 πŸ‘ 1 Β· πŸ‘Ž 0 ⭐ 8 Anki 25.02.7~ Updated 2025-08-23
AINotePro: AI Text and Audio for Anki

Generates AI text and MP3 audio from note fields via configurable OpenAI-compatible providers and Edge TTS, supporting prompt templates, vision OCR, batch notes, and local settings storage.

card-creationai

Rating 1 πŸ‘ 1 Β· πŸ‘Ž 0 ⭐ 2 Anki 26.05~ Updated 2026-06-27
Localize Media

Downloads remote media links and converts inlined images into local Anki media references for selected cards, with audio support, via the Browse screen's Notes menu.

note-managementformatting

Rating 29 πŸ‘ 29 Β· πŸ‘Ž 0 Anki 23.10~ Updated 2023-10-19

README

AnkiBeacon

AnkiBeacon posts JSON events from Anki to local or remote HTTP receivers.

The current release emits note_added events when Anki creates notes through Collection.add_note() or Collection.add_notes(). It also sends an optional heartbeat so external apps can prefer push delivery while Anki is running and fall back to polling only when the heartbeat expires.

The add-on package/folder name remains new_card_created for compatibility. The public project name is AnkiBeacon, leaving room for more webhook event types in future releases.

Configuration

Edit the add-on config in Anki from Tools > Add-ons > AnkiBeacon > Config, or edit config.json directly while developing.

{
  "defaults": {
    "timeout_seconds": 5,
    "headers": {},
    "show_error_tooltips": true
  },
  "operations": [
    {
      "operation": "note_added",
      "enabled": true,
      "urls": [
        "http://127.0.0.1:7275/anki/events"
      ],
      "payload_mode": "note_id"
    },
    {
      "operation": "heartbeat",
      "enabled": true,
      "urls": [],
      "fallback_operation": "note_added",
      "interval_seconds": 10,
      "show_error_tooltips": false
    }
  ]
}

Each entry in operations owns the URLs and options for one event stream. If the heartbeat operation has no URLs, it uses fallback_operation to send heartbeats to the note_added URLs, and the receiver should branch on event.

Events

note_added

{
  "addon": "new_card_created",
  "addon_name": "AnkiBeacon",
  "protocol_version": 1,
  "session_id": "9b2b4eb1d7e046b5a2f916f35f2f9ef1",
  "event": "note_added",
  "source": "add_note",
  "created_at": "2026-04-22T23:00:00+00:00",
  "note_id": 1234567890,
  "deck_id": 987654321
}

payload_mode: "note" adds note fields, tags, card IDs, and basic card metadata.

heartbeat

{
  "addon": "new_card_created",
  "addon_name": "AnkiBeacon",
  "protocol_version": 1,
  "session_id": "9b2b4eb1d7e046b5a2f916f35f2f9ef1",
  "event": "heartbeat",
  "status": "ready",
  "sent_at": "2026-04-22T23:00:00+00:00",
  "heartbeat_interval_seconds": 10,
  "payload_mode": "note_id",
  "capabilities": ["heartbeat", "note_added"]
}

See INTEGRATION.md for receiver guidance.

AnkiWeb Upload

Create the .ankiaddon archive from inside this folder so the archive root contains files such as __init__.py, config.json, and manifest.json.

Do not include the containing new_card_created folder, __pycache__ folders, or local meta.json state in the upload archive.