Capabilities
catalogstatediscoveraboutstream-mapsschema-flattening
Settings
| Setting | Required | Default | Description |
|---|---|---|---|
| api_key | True | None | Authentication key. See https://api.jotform.com/docs/#authentication |
| api_url | False | https://api.jotform.com | API Base URL |
| user_agent | False | tap-jotform/0.0.1 | User-Agent header |
| start_date | False | None | Start date for data collection |
| requests_cache | False | None | Cache configuration for HTTP requests |
| 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. |
A full list of supported settings and capabilities is available by running: tap-jotform --about
Streams
| Stream name | API endpoint | API docs | Notes |
|---|---|---|---|
| forms | /user/forms | https://api.jotform.com/docs/#user-forms | Replication for this stream is opt-in. See instructions below. |
| questions | /form/{form_id}/questions | https://api.jotform.com/docs/#form-id-questions | |
| submissions | /user/submissions | https://api.jotform.com/docs/#user-submissions | Replication for this stream is opt-in. See instructions below. |
| reports | /user/reports | https://api.jotform.com/docs/#user-reports | |
| user_history | /user/history | https://api.jotform.com/docs/#user-history | |
| folders (deprecated) | /user/folders | https://api.jotform.com/docs/#user-folders | |
| labels | /user/labels | https://api.jotform.com/docs/#get-user-labels |
Configuring incremental replication
By default, the forms and submissions stream are synced with FULL_TABLE replication. Incremental replication can be enabled by setting the replication metadata in the stream's entry in the catalog file:
replication_method: set toINCREMENTALreplication_keyset tocreated_atorupdated_at. The former will omit updated submissions, while the latter will omit new submissions.
For example, to enable incremental replication for the submissions stream:
{
"streams": [
{
"tap_stream_id": "submissions",
"stream": "submissions",
"replication_method": "INCREMENTAL",
"replication_key": "updated_at",
}
]
}
Source Authentication and Authorization
To generate an API key, follow the instructions in https://api.jotform.com/docs/#gettingstarted.
Usage
You can easily run tap-jotform by itself or in a pipeline using Meltano.
Executing the Tap Directly
tap-jotform --version
tap-jotform --help
tap-jotform --config CONFIG --discover > ./catalog.json
Developer Resources
Initialize your Development Environment
curl -LsSf https://astral.sh/uv/install.sh | sh # or see https://docs.astral.sh/uv/getting-started/installation/
uv sync
Create and Run Tests
Create tests within the tap_jotform/tests subfolder and
then run:
uv run pytest
You can also test the tap-jotform CLI interface directly using uv run:
uv run tap-jotform --help
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.
Use Meltano to run an EL pipeline:
# Test invocation:
uvx meltano invoke tap-jotform --version
# OR run a test `elt` pipeline:
uvx meltano run tap-jotform 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.
Metadata
Release files for tap-jotform 0.7.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tap_jotform-0.7.8.tar.gz | 72.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tap_jotform-0.7.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 85.6 kB
Release files / tap_jotform-0.7.8.tar.gz
| Download URL | tap_jotform-0.7.8.tar.gz |
|---|---|
| Size | 72.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c42f1125e2b80f119ac6787b8964520fe93d505aed5b6bd73f0cce54932ec458
|
|
BLAKE2b-256 checksum How to use checksums |
c5db2470fcdd6934b8f1886ba522982a63a2021d27dab79dae3be27ddb27cb3e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 22, 2026.
Transparency logRelease files / tap_jotform-0.7.8-py3-none-any.whl
| Download URL | tap_jotform-0.7.8-py3-none-any.whl |
|---|---|
| Size | 12.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
74349862e79728d6c781abe070a270c0dffbe3ff768ea06545e0c4ff7c3117de
|
|
BLAKE2b-256 checksum How to use checksums |
1fdf849bdd9ac170e7f6801cb1ea50a90ecae3d617009438e8593f508e9d9b77
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 22, 2026.
Transparency log
