Capabilities

• catalog
• state
• discover
• activate-version
• about
• stream-maps
• schema-flattening
• batch
• structured-logging

Supported Python Versions

• 3.12
• 3.13
• 3.14

Settings

Setting	Required	Default	Description
api_key	True	None	API Key for Healthchecks.io

Built-in Settings

The following settings are automatically handled by the SDK:

Setting	Required	Default	Description
stream_maps	False	None	Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config	False	None	User-defined config values to be used within map expressions.
faker_config	False	None	Config for the Faker instance variable fake used within map expressions. Only applicable if the plugin specifies faker as an additional dependency (through the singer-sdk faker extra or directly).
faker_config.seed	False	None	Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
faker_config.locale	False	None	One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
flattening_enabled	False	None	'True' to enable schema flattening and automatically expand nested properties.
flattening_max_depth	False	None	The max depth to flatten schemas.
batch_config	False	None
batch_config.encoding	False	None	Specifies the format and compression of the batch files.
batch_config.encoding.format	False	None	Format to use for batch files.
batch_config.encoding.compression	False	None	Compression format to use for batch files.
batch_config.storage	False	None	Defines the storage layer to use when writing batch files
batch_config.storage.root	False	None	Root path to use when writing batch files.
batch_config.storage.prefix	False	None	Prefix to use when writing batch files.

A full list of supported settings and capabilities is available by running: tap-healthchecksio --about

Source Authentication and Authorization

Create a read-only API key by visiting https://healthchecks.io/projects/<check-uuid>/settings/ and provide it in the api_key setting.

Usage

You can easily run tap-healthchecksio by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-healthchecksio --version
tap-healthchecksio --help
tap-healthchecksio --config CONFIG --discover > ./catalog.json

Developer Resources

Initialize your Development Environment

uv tool install --with tox-uv tox

Create and Run Tests

Run all tests:

tox run-parallel

Testing with Meltano

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Your project comes with a custom meltano.yml project file already created. Go ahead and install Meltano if you haven't already.

1. Install all plugins

   meltano install

2. Check that the extractor is working properly

   meltano invoke tap-healthchecksio --version

3. Execute an ELT pipeline

   meltano run tap-healthchecksio target-jsonl

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.