canonical: https://jentic.com/apis/waywedo.com/waywedo

# Way We Do Integration API

RESTful API endpoints for integrating external applications with Way We Do. The API exposes 19 endpoints secured with apiKey authentication.

## For AI agents

Programmatically register for a webhook event, delete all webhook registrations. Covers 19 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Register for a webhook event
- Delete all webhook registrations
- Get a webhook registration
- Add a new user
- Find user

## Use cases

### Developer Tools Operations

Use the Way We Do Integration API to perform developer tools operations programmatically. The API provides 19 endpoints covering core functionality including register for a webhook event, delete all webhook registrations, get a webhook registration.

Example prompt: Call POST `/v1/webhook` to register for a webhook event

### Automated Checklist Instance Activity Management

Automate checklist instance activity operations by combining multiple Way We Do Integration API endpoints. Agents can delete all webhook registrations and then get a webhook registration in a single workflow.

Example prompt: Call DELETE `/v1/webhook` to delete all webhook registrations, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Way We Do Integration 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 'register for a webhook event', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/webhook` | Register for a webhook event |
| DELETE | `/v1/webhook` | Delete all webhook registrations |
| GET | `/v1/webhook/{webhookId}` | Get a webhook registration |
| DELETE | `/v1/webhook/{webhookId}` | Delete a webhook registration |
| POST | `/v1/Users` | Add a new user |
| GET | `/v1/Users` | Find user |
| GET | `/v1/Users/{userId}` | Get a user |
| GET | `/v1/TimeZones` | List time zones |

## Key resources

- **Checklist Instance Activity** — Operations related to Checklist Instance Activity
- **Checklist Instance Collaborators** — Operations related to Checklist Instance Collaborators
- **Checklist Instance Comments** — Operations related to Checklist Instance Comments
- **Checklist Instance Steps** — Operations related to Checklist Instance Steps
- **Checklist Instances** — Operations related to Checklist Instances

## 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:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 46 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/waywedo.com/waywedo/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 <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Way We Do Integration API by hand means learning its API key header, pointing at api.waywedo.com, and handling responses yourself. Through Jentic you install once, import the Way We Do Integration API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Way We Do puts the resource id in the URL path (`/v1/webhook/{webhookId}`, `/v1/Users/{userId}`), so a rule can pin your agent to one webhook or user and nothing else. You choose the operations it may call, so destructive ones like deleting a webhook are not included unless you add them.
- **Credential handling:** Your Way We Do 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 'register for a webhook event' or 'list users', and Jentic returns the matching Way We Do 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 Way We Do Integration API use?

The Way We Do Integration API uses an API key passed in the `Authorization` 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 register for a webhook event with the Way We Do Integration API?

Yes. Use the POST `/v1/webhook` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Way We Do Integration 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 register for a webhook event through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'register for a webhook event'. Jentic returns the matching Way We Do Integration API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Way We Do Integration API have?

The Way We Do Integration API exposes 19 endpoints covering checklist instance activity, checklist instance collaborators, checklist instance comments operations.

### Can I limit what my agent is allowed to do with the Way We Do Integration API?

Yes. Because you run Jentic One yourself, your own rules decide which Way We Do operations and credentials the agent may use. Since Way We Do puts the resource id in the URL path, such as `/v1/webhook/{webhookId}` and `/v1/Users/{userId}`, a rule can pin the agent to a single webhook or user and nothing else. You also choose the operations it may call, so destructive ones like deleting a webhook are excluded unless you add them.