> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# YCloud Developer Kit

> Build YCloud integrations with AI coding skills for Codex, Claude Code, and WorkBuddy.

YCloud Developer Kit helps your AI coding agent plan integrations, generate server-side code, and test workflows in your existing project. Describe what you want to build, such as WhatsApp order notifications, appointment reminders, or customer support, and the agent uses YCloud API contracts to guide the work.

You can also ask the agent to review an existing integration or perform a specific live API operation with your configured server-side credentials.

## Before you begin

For installation and local development, you need:

* Codex, Claude Code, or WorkBuddy.
* Node.js and `npx` available in your terminal.
* The project where you want to build your integration.

You do not need a YCloud API key for the installation check or tests that use mocks. For live API requests, you need a YCloud account, a server-side API key, and the resources required by your workflow. See [Authentication](https://docs.ycloud.com/en/api-reference/guides/api-fundamentals/authentication.md) for credential setup.

## Install the skills

Run the command for your coding agent from your project directory. Each command installs the full set of 17 skills in that project.

> [tab] Codex
>
> ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
> npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*' -a codex --copy -y
> ```

> [tab] Claude Code
>
> ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
> npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*' -a claude-code --copy -y
> ```

> [tab] WorkBuddy
>
> WorkBuddy uses the CodeBuddy-compatible skill directory, `.codebuddy/skills/`.
>
> ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
> npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*' -a codebuddy --copy -y
> ```

To choose your coding agent interactively, run:

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
npx skills add YCloud-Developers/YCloud-Developer-Kit --skill '*'
```

You can find versioned plugin ZIP packages and checksums on the [official releases page](https://github.com/YCloud-Developers/YCloud-Developer-Kit/releases).

## Check the installation

Start a new session in your coding agent and send:

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
Use ycloud-developer-kit-smoke-test to check that YCloud Developer Kit is ready.
```

The expected response is:

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
YCloud Developer Kit is ready. No external API was called.
```

This check confirms that the agent can discover and invoke the readiness skill. It does not read credentials, call YCloud, or validate your account configuration.

If the agent cannot find the skill, confirm that you ran the installation command in the correct project, selected the correct agent, and opened a new session for that project.

## Build your first integration

Describe your business goal, project stack, and the result you need. Start with `ycloud-integration-architect` when the workflow spans several capabilities, such as templates, message sending, and webhooks.

For example, send this prompt from your application project:

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
Use ycloud-integration-architect to add WhatsApp order notifications to this project.
Reuse the existing framework and configuration patterns.
Send an existing approved template and handle delivery-status webhooks.
Keep the API key on the server and verify webhook signatures.
Add local tests with synthetic data and mocked YCloud responses.
Report the files changed, test results, and remaining setup.
```

The agent uses the relevant domain skills for your selected workflow. Review the generated code and test results, then configure the required YCloud resources before requesting a live test.

Give the agent the following context when it is relevant:

| Context | Example |
| - | - |
| Business goal | Send an order confirmation through WhatsApp. |
| Existing stack | Reuse this project's Node.js backend and test runner. |
| Scope | Use an existing template; do not create or edit templates. |
| Test environment | Use mocks with synthetic customer and message IDs. |
| Live operation | Retrieve the balance for the specified account using its configured credential reference. |
| Expected result | Server-side code, local tests, and a list of remaining configuration steps. |

Reference credentials through your server configuration or secret manager. Do not paste API keys or webhook signing secrets into prompts.

## What the kit covers

Version `0.7.13` includes 17 skills covering 88 API operations, plus API authentication and webhook receiving. The table groups the domain skills by the work you can request.

| Capability | Skill | Typical tasks |
| - | - | - |
| API authentication | `ycloud-api-authentication` | Configure server-side API keys and plan key rotation. |
| WhatsApp messages | `ycloud-whatsapp-messages` | Send messages directly or through the queue, and retrieve messages. |
| WhatsApp media | `ycloud-whatsapp-media` | Upload media for a message workflow. |
| WhatsApp templates | `ycloud-whatsapp-templates` | Create, list, retrieve, edit, and delete templates; retrieve analytics. |
| Webhooks | `ycloud-webhook-endpoints` | Manage endpoints and build receivers with signature verification. |
| WhatsApp Business Accounts | `ycloud-whatsapp-business-accounts` | List and retrieve accounts; manage automatic creative optimization settings. |
| WhatsApp phone numbers | `ycloud-whatsapp-phone-numbers` | Manage registration, profiles, display names, usernames, and settings. |
| WhatsApp Groups | `ycloud-whatsapp-groups` | Manage groups, membership, join requests, and invite links. |
| WhatsApp Flows | `ycloud-whatsapp-flows` | Create, update, preview, publish, deprecate, and delete Flows. |
| Inbound message acknowledgements | `ycloud-whatsapp-inbound-messages` | Mark received messages as read or show a typing indicator. |
| WhatsApp Calling | `ycloud-whatsapp-calling` | Manage call sessions and download call media. |
| Account balance | `ycloud-balance` | Retrieve the account balance. |
| Contacts | `ycloud-contacts` | Manage contacts and notes, and list contact attributes. |
| Custom events | `ycloud-custom-events` | Manage event definitions and properties, and submit contact-associated events. |
| Unsubscribe preferences | `ycloud-unsubscribers` | Create, retrieve, list, and delete unsubscribe records. |

The remaining two skills are `ycloud-integration-architect`, which coordinates workflows across domains, and `ycloud-developer-kit-smoke-test`, which checks installation readiness.

> [!NOTE]
>
> This release does not cover SMS, Verify, Voice, or Email integrations. Those products remain available through YCloud APIs. Use their API guides and reference pages for integration details.

## More example prompts

### Add inbound messages and webhooks

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
Use YCloud Developer Kit to add WhatsApp inbound-message handling to this backend.
Verify webhook signatures and handle duplicate events.
Add local tests for valid signatures, invalid signatures, and repeated delivery.
Report the implementation changes and test results.
```

### Review an existing integration

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
Review this project's YCloud WhatsApp integration.
Check server-side authentication, request and response handling, delivery-status
webhooks, error handling, and retry behavior against the supported contracts.
Report findings and suggested fixes without changing files or calling live APIs.
```

### Request a live read

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
Use ycloud-balance to retrieve the balance for the YCloud account identified in
this project's server configuration. Use the configured credential reference
without displaying the key. Report the returned amount and currency.
```

## Local tests and live operations

Local mock tests let you check application behavior with synthetic data. A passing mock test does not confirm live authentication, message delivery, or production deployment.

For live operations, specify the account, environment, target resources, and action. The agent uses the configured credentials within that scope. It asks for missing details when the target or effects are unclear. A request to develop code locally does not authorize unrelated live changes.

For message sends and other asynchronous operations, distinguish an accepted request from its final outcome. Verify delivery or completion through the relevant retrieval API or webhook. If a live change times out, check the available resource state before retrying.

## Next steps

> [card] [Send a WhatsApp message](https://docs.ycloud.com/en/api-reference/guides/whatsapp-platform/send-whatsapp-message.md)
>
> Prepare message templates, payloads, and delivery handling.

> [card] [Configure webhooks](https://docs.ycloud.com/en/api-reference/guides/api-fundamentals/configure-webhooks.md)
>
> Connect your application to inbound messages and status updates.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.