`tap-hookdeck`

Singer tap for Hookdeck.

Capabilities

catalog
state
discover
about
stream-maps
schema-flattening
batch

Settings

Setting	Required	Default	Description
api_key	True	None	API Key for Hookdeck
start_date	False	None	Earliest datetime to get data from
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.
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

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

Supported Python Versions

3.12
3.13
3.14

Source Authentication and Authorization

See https://hookdeck.com/docs/api#authentication.

Usage

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

Executing the Tap Directly

tap-hookdeck --version
tap-hookdeck --help
tap-hookdeck --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.

Install all plugins
```
meltano install
```
Check that the extractor is working properly
```
meltano invoke tap-hookdeck --version
```
Execute an ELT pipeline
```
meltano run tap-hookdeck 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.