canonical: https://jentic.com/apis/workee.ai/workee # Workee API Workee API for managing Zapier webhook connections and triggers. The API exposes 4 endpoints secured with apiKey authentication. ## For AI agents Programmatically test zapier connection, subscribe trigger. Covers 4 operations with apiKey authentication. ## Scope Does not handle payments, communications, or crm - use for developer tools only. ## Capabilities - Test Zapier connection - Subscribe trigger - Unsubscribe trigger - Get sample data - Monitor Workee API operational status and events ## Use cases ### Developer Tools Operations Use the Workee API to perform developer tools operations programmatically. The API provides 4 endpoints covering core functionality including test zapier connection, subscribe trigger, unsubscribe trigger. Example prompt: Call GET `/zapier/connections/test` to test zapier connection ### Automated Connections Management Automate connections operations by combining multiple Workee API endpoints. Agents can subscribe trigger and then unsubscribe trigger in a single workflow. Example prompt: Call POST `/zapier/connections/subscribe` to subscribe trigger, then verify the result ### AI Agent Integration via Jentic AI agents discover and call Workee API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually. Example prompt: Search Jentic for 'test zapier connection', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/zapier/connections/test` | Test Zapier connection | | POST | `/zapier/connections/subscribe` | Subscribe trigger | | POST | `/zapier/connections/unsubscribe` | Unsubscribe trigger | | GET | `/zapier/connections/sample-data` | Get sample data | ## Key resources - **Connections** — Operations related to Connections ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 60 / 100 - **Maturity:** AI-Aware - **Dimensions:** - Foundational Compliance: 100 / 100 - Developer Experience & Jentic Compatibility: 64 / 100 - AI-Readiness & Agent Experience: 36 / 100 - Agent Usability: 94 / 100 - Security: 50 / 100 - AI Discoverability: 100 / 100 - **View full report:** https://jentic.com/apis/workee.ai/workee/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring the Workee API by hand means setting up its header API key and managing the Zapier connection lifecycle yourself. Through Jentic you install once, import the Workee API from the API Directory, store the API key once, and your agent calls it. - **Permission scoping:** The Workee API carries its target in the request body rather than the URL path, so scope by operation: limit the agent to the operations it needs, such as testing a connection or fetching sample data. You choose that set, so subscribe and unsubscribe calls are not included unless you add them. - **Credential handling:** Your Workee API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'test a Zapier connection' or 'get sample data', and Jentic returns the matching Workee API operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Github** — Alternative developer tools API - **Gitlab** — Alternative developer tools API ## FAQ ### What authentication does the Workee API use? The Workee API uses an API key passed in the `X-API-KEY` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context. ### Can I test zapier connection with the Workee API? Yes. Use the GET `/zapier/connections/test` endpoint. The API returns structured JSON responses that agents can parse and act on directly. ### What are the rate limits for the Workee API? Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer. ### How do I test zapier connection through Jentic? Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'test zapier connection'. Jentic returns the matching Workee API operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the Workee API have? The Workee API exposes 4 endpoints covering connections operations. ### Can I limit what my agent is allowed to do with the Workee API? Yes. Jentic One is self-hosted, so your own rules decide which Workee API operations and credentials the agent may use. Because the Workee API carries its target in the request body rather than the URL path, you scope by operation: you can allow the agent only the calls it needs, such as testing a Zapier connection or fetching sample data, while leaving out the subscribe and unsubscribe calls unless you explicitly add them. The stored API key is injected only for the operations you have allowed.