Clappia API Tools

Clappia APIs SDK

PyPI - Python Version License: MIT

Overview

Clappia API Tools is a Python package that provides a set of clients for seamless integration with the Clappia API. It enables developers to automate workflows, manage submissions, and interact with Clappia apps programmatically. The package is designed for use in automation, data integration, and agent-based systems (e.g., LangChain agents, MCP).

Features

  • Multiple API Clients: Dedicated clients for each Clappia API operation.
  • Submission Management: Create, edit, update owners, and change status of submissions.
  • App Definition Retrieval: Fetch complete app structure and metadata and manage the app structure via fields and sections updates.
  • Workflow Management: Retrieve, create, modify, and manage workflow definitions and steps.
  • Analytics Management: Add, update, and reorder charts and analytics configurations.

Available Clients

  • SubmissionClient: Manage submissions (create, edit, update owners, change status)
  • AppDefinitionClient: Retrieve app definitions and metadata and Manage app structure (fields, sections, creation)
  • WorkflowDefinitionClient: Manage workflow definitions (get, add, update, reorder workflow steps)
  • AnalyticsClient: Manage analytics and charts (add, update, reorder charts)

Documentation

Installation

pip install clappia-api-tools

Or, for development:

git clone https://github.com/clappia-dev/clappia-api-tools.git
cd clappia-api-tools
pip install -e ."[dev]"

Configuration

You must provide your Clappia API credentials and workspace information directly when initializing any client:

  • api_key: Your Clappia API key
  • base_url: The base URL for the Clappia API (e.g., https://api.clappia.com)

Usage

SubmissionClient Example

from clappia_api_tools.client.submission_client import SubmissionClient

client = SubmissionClient(
    api_key="your-api-key",
    base_url="https://api.clappia.com",
)

# Create a submission
result = client.create_submission(
    app_id="MFX093412",
    data={"employee_name": "John Doe", "department": "Engineering"},
)
print(result)

AppDefinitionClient Example

from clappia_api_tools.client.app_definition_client import AppDefinitionClient

client = AppDefinitionClient(
    api_key="your-api-key",
    base_url="https://api.clappia.com",
)

# Get app definition
result = client.get_definition(app_id="MFX093412")
print(result)

WorkflowDefinitionClient Example

from clappia_api_tools.client.workflow_definition_client import WorkflowDefinitionClient

client = WorkflowDefinitionClient(
    api_key="your-api-key",
    base_url="https://api.clappia.com",
)

# Get workflow definition
result = client.get_workflow(
    app_id="MFX093412",
    trigger_type="submissionCreated",
)
print(result)

# Add a workflow step
add_result = client.add_step(
    app_id="MFX093412",
    trigger_type="submissionCreated",
    node_type="Email",
)
print(add_result)

AnalyticsClient Example

from clappia_api_tools.client.analytics_client import AnalyticsClient

client = AnalyticsClient(
    api_key="your-api-key",
    base_url="https://api.clappia.com",
)

# Add a chart
result = client.add_chart(
    app_id="MFX093412",
    chart_type="Bar",
    chart_title="Sales Overview"
)
print(result)

# Update chart configuration
update_data = {
    "chart_title": "Updated Sales Overview",
    "dimensions": ["region"],
    "metrics": ["sales_amount"]
}
update_result = client.update_chart(
    app_id="MFX093412",
    chart_index=0,
    update_data=update_data
)
print(update_result)

Contributing

  1. Fork the repository and create your branch.
  2. Write clear, well-documented code and tests.
  3. Run pytest and ensure all tests pass.
  4. Submit a pull request with a clear description of your changes.

License

This project is licensed under the MIT License. See LICENSE for details.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.0.29)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for sarthak-clappia from gravatar.com sarthak-clappia

Credits

Author: Rishabh Verma

License

MIT License (MIT)

Requires

Python >=3.10

Provides Extra

dev docs security

Tags

clappia client mcp rest-apis tools workchat agents

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clappia_api_tools-2.0.28.tar.gz (60.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clappia_api_tools-2.0.28-py3-none-any.whl (71.7 kB view details)

Uploaded Python 3

File details

Details for the file clappia_api_tools-2.0.28.tar.gz.

File metadata

  • Download URL: clappia_api_tools-2.0.28.tar.gz
  • Upload date:
  • Size: 60.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for clappia_api_tools-2.0.28.tar.gz
Algorithm Hash digest
SHA256 bfb36b26a168cf1b5c6785d00191b6f41015065c555659229e67886a9d8fbb99
MD5 ffcb14676faa198fb2c62b8adf3a11ca
BLAKE2b-256 5fda72bb9109eff3c4609d12069f3d4ecda2169e9552c0da5bc51d8d33bbb3a9

See more details on using hashes here.

Provenance

The following attestation bundles were made for clappia_api_tools-2.0.28.tar.gz:

Publisher: publish.yml on clappia-dev/clappia-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file clappia_api_tools-2.0.28-py3-none-any.whl.

File metadata

File hashes

Hashes for clappia_api_tools-2.0.28-py3-none-any.whl
Algorithm Hash digest
SHA256 f582604d2319ec2c0e91a476af762038456b57cbcf156bc48c819303bd18c5ea
MD5 9683746421e881ec6439e6400d052f2f
BLAKE2b-256 8267efbcef15172e948d3dfd9715b43113803bdb157a37715b44ecfc39d77211

See more details on using hashes here.

Provenance

The following attestation bundles were made for clappia_api_tools-2.0.28-py3-none-any.whl:

Publisher: publish.yml on clappia-dev/clappia-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

2.0.29

2 files

This release

2.0.28 This release

2 files

2.0.27

2 files

2.0.26

2 files

2.0.25

2 files

2.0.24

2 files

2.0.23

2 files

2.0.22

2 files

2.0.21

2 files

2.0.20

2 files

2.0.19

2 files

2.0.18

2 files

2.0.17

2 files

2.0.16

2 files

2.0.15

2 files

2.0.14

2 files

2.0.13

2 files

2.0.12

2 files

2.0.11

2 files

2.0.10.post1

2 files

2.0.10

2 files

2.0.9

2 files

2.0.8

2 files

2.0.7

2 files

2.0.6

2 files

2.0.5

2 files

2.0.4

2 files

2.0.3

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

1.0.1

2 files

1.0.0

2 files

0.1.6

2 files

0.1.5

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page