> ## Documentation Index > Fetch the complete documentation index at: https://woku.app/docs/llms.txt > Use this file to discover all available pages before exploring further. # Manage an approved plan inside woku > `provider`: `internal` (manage the plan inside woku). It is the only provider available on the public API. Requires the plan to be `approved`; applies synchronously, moving it to `in_progress`. ## OpenAPI ````yaml /openapi-v1.json post /v1/action-plans/{id}/send openapi: 3.0.3 info: title: Woku Client API v1 description: >- Public Woku Client API. Switch the version selector at the top to view the v0 reference. This spec covers: - **Wokus**: create wokus, fetch review data, submit text/voice reviews, share by email. - **Companies**: `GET /companies/me` returns the caller company. - **Reports**: company-wide and per-tool NPS reports. - **External Trackers**: tag your Wokus with identifiers from third-party systems (CRM transaction id, ERP order id, etc.) and look them up later. - **Ticket Destinations**: configure Zendesk, a custom HTTP service or email addresses that receive AI-triaged support tickets, and the tracker conditions that route a ticket to one. - **Action Plan Groups**: define which VoC feedback (tracker conditions) drafts an improvement plan and who is responsible. - **Action Plans**: read AI-drafted plans and drive their lifecycle (approve and work them in woku's managed kanban). ## Authentication All endpoints require a Bearer token in the `Authorization` header. Obtain your company API key from the Woku dashboard. ``` Authorization: Bearer your_api_key_here ``` ## Base URL Production: `https://clientapi.woku.app` ## Model (External Trackers) - **Tracker definition** (`ExternalTracker`): a per-company catalog entry like `{ name: 'trr', system: 'crm interno', description: '...' }`. Defined by an admin in the Woku dashboard. - **Tracker value** (`WokuExternalTrackerValue`): a string value bound to a (Woku, Tracker) pair. Multiple Wokus may share the same value. ## Model (routing / group conditions) `TicketRoutingCondition` (Ticket Destinations) and `ActionPlanGroupCondition` (Action Plan Groups) share the same shape: a boolean expression of rows over `ExternalTracker` values, AND binding tighter than OR. Each row matches when the feedback carries `trackerId` with a value that, for operator `equals`, equals `value`, or, for operator `any`, is any value at all (the whole tracker; `value` is then omitted). `relationToPrevious` joins a row to the previous one (`AND` same group, `OR` starts a new group); the first row omits it. version: 1.0.0 contact: name: Woku Support url: https://woku.app email: team@woku.app servers: - url: https://clientapi.woku.app description: Production server security: [] tags: - name: Wokus description: >- Create wokus, fetch review data, submit text and voice reviews, share review links by email. - name: Companies description: Caller-company endpoint. - name: Reports description: NPS reports for the caller company and individual NPS tools. - name: NPS description: >- Capture NPS scores (company-level or per NPS tool) and fetch NPS tool definitions. - name: CSAT description: >- Capture CSAT (1-5 satisfaction) scores company-level or per CSAT tool, fetch tool definitions and responses, and submit text and voice feedback. - name: CES description: >- Capture CES (effort) scores company-level or per CES tool, fetch tool definitions and responses, and submit text and voice feedback. - name: External Trackers description: >- Tag Wokus with identifiers from external systems and look them up by name + value. - name: Quarantines description: >- Check whether a respondent is currently quarantined before prompting for feedback. - name: Invitations description: >- Survey distribution: send NPS surveys, forms and woku review invitations by email or WhatsApp. - name: Forms description: Fetch form definitions and submit responses from your own UI. - name: Flows description: Render flow journeys (ordered wokus with an optional NPS) in your own app. - name: Captures description: Mobile SDK capture ingestion - name: Ticket Destinations description: >- Configure where AI-triaged support tickets are delivered (Zendesk, a custom HTTP service, or plain email) and the tracker-based routing that picks a destination. - name: Action Plan Groups description: >- Define which VoC feedback (tracker conditions) drafts an action plan and who the responsibles are. - name: Action Plans description: >- Read AI-drafted improvement plans and drive their lifecycle: approve, and work them inside woku's managed kanban. - name: Tickets description: Read and curate the AI-generated support tickets. - name: Dispatches description: Delivery tracking and response rate over the invitation dispatches. - name: Health description: Service healthcheck for the v1 namespace. paths: /v1/action-plans/{id}/send: post: tags: - Action Plans summary: Manage an approved plan inside woku description: >- `provider`: `internal` (manage the plan inside woku). It is the only provider available on the public API. Requires the plan to be `approved`; applies synchronously, moving it to `in_progress`. operationId: sendActionPlan parameters: - $ref: '#/components/parameters/ActionPlanIdPath' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendActionPlanRequest' examples: internal: summary: Work the plan inside woku (managed kanban) value: provider: internal responses: '202': description: Send accepted content: application/json: schema: $ref: '#/components/schemas/SendActionPlanResponse' '400': description: Invalid or missing target for the provider content: application/json: schema: $ref: '#/components/schemas/ValidationError' '403': description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Plan not found content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '409': description: >- Invalid status transition (wrong status for the chosen provider), or a send is already in progress for this plan content: application/json: schema: $ref: '#/components/schemas/ConflictError' security: - BearerAuth: [] components: parameters: ActionPlanIdPath: name: id in: path required: true description: MongoDB ObjectId of the action plan. schema: type: string pattern: ^[0-9a-fA-F]{24}$ example: 507f1f77bcf86cd799439041 schemas: SendActionPlanRequest: type: object required: - provider properties: provider: type: string enum: - internal description: >- `internal` is the only provider available on the public API: the plan is managed inside woku (no target, no external call), moving to `in_progress` so its tasks are worked with the task endpoints below. resourceLabel: type: string maxLength: 300 description: >- Human destination summary (e.g. "Operaciones CX ยท Backlog"), persisted as `delivery.resourceLabel`. SendActionPlanResponse: type: object properties: status: type: string enum: - managed description: '`managed` for `internal`, applied synchronously.' ValidationError: type: object properties: statusCode: type: integer example: 400 message: oneOf: - type: string - type: array items: type: string error: type: string example: Bad Request ForbiddenError: type: object properties: statusCode: type: integer example: 403 message: type: string example: Authentication required error: type: string example: Forbidden NotFoundError: type: object properties: statusCode: type: integer example: 404 message: type: string example: External tracker not found error: type: string example: Not Found ConflictError: type: object properties: statusCode: type: integer example: 409 message: type: string example: Cannot approve a plan in status "approved" error: type: string example: Conflict securitySchemes: BearerAuth: type: http scheme: bearer description: >- Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints. ````