Scheduled report emails

​

What the email carries

• The PDF report of the period: first a metrics page (responses, average, recognitions and improvements, sentiment, score distribution and word cloud), then the AI comment analysis.
• For a folder, the CSV of the responses of the period, if you turn it on.
• A one-click unsubscribe link. Whoever unsubscribes stops getting that company’s reports; the rest of woku’s emails do not change.

​

Frequencies

​

In the app

• The list of scheduled emails of that report, each with its next send or its status, and the actions Send now, Pause or Resume, Edit and Delete.
• The form to add one: frequency (with the date of the next send), recipients (up to 10 emails, separated by commas or on separate lines) and, for a folder, whether it attaches the CSV. For a one-off you choose the period and whether it goes out now or on a date.

​

API, SDK and MCP

• GET /v1/report-subscriptions lists them (optionally of one folder or tool, with scopeType and scopeId).
• POST /v1/report-subscriptions creates one: scopeType (folder, woku, nps, csat or ces), scopeId, frequency (monthly, biweekly, weekly or once), recipients, and optionally includeCsv and locale. A once email takes periodFrom and periodTo (ISO, periodTo exclusive) and sendAt; without sendAt it goes out within minutes.
• PATCH /v1/report-subscriptions/:id edits a recurring one, or pauses (active: false) and resumes it.
• DELETE /v1/report-subscriptions/:id deletes it.
• POST /v1/report-subscriptions/:id/send sends it now: the last complete period of a recurring one, or the own period of a one-off.

const monthly = await woku.reportSubscriptions.create({
  scopeType: 'folder',
  scopeId: folderId,
  frequency: 'monthly',
  recipients: ['board@company.com'],
  includeCsv: true,
});
await woku.reportSubscriptions.update(monthly.id, { active: false });

monthly = woku.report_subscriptions.create(
    {
        "scopeType": "folder",
        "scopeId": folder_id,
        "frequency": "monthly",
        "recipients": ["board@company.com"],
        "includeCsv": True,
    }
)
woku.report_subscriptions.update(monthly["id"], {"active": False})