How to Create a Scheduled Task in Wyn Enterprise Using the API

Background:

A scheduled task in Wyn allows users to execute a manual, one-time, or recurring operation on a document.

As part of our ongoing efforts to make Wyn easier and more flexible to use, we have introduced a new API endpoint. This endpoint enables administrative users to create and manage scheduled tasks programmatically.

With this API, you can create tasks that:

• Export reports or dashboards to various formats (PDF, Excel, etc.)
• Deliver results via email (as attachment, link, or embedded body)
• Save output to local storage
• Send output to external storage (FTP, SFTP, AWS S3, Azure Blob, etc.)
• Export to file shares (SMB)
• Refresh datasets or data models on a schedule
• Run as one-time, recurring (cron-based), or manually triggered tasks

The newly introduced API Endpoint is /api/v2/scheduler/tasks

Request Details:

Authentication: 

All API requests require a valid access token.
Pass the token as a query parameter

?token=YOUR_ACCESS_TOKEN

or in the request header

Reference-Token = YOUR_ACCESS_TOKEN

Request Parameters: 

None

Request Body Reference 

Top-Level Properties 

In this knowledge base, we use an example that schedules a task to run every weekday at 08:00 Eastern Time.

Requirements:

• Task Type: Report Export
• Distribution Channel (deploy to): Email
• Occurrence: Every weekday at 08:00 Eastern Time
• Receivers: Multiple
• Export Templates: No

cURL Example.

curl --location 'http://localhost:51980/api/v2/scheduler/tasks' \
--header 'Reference-Token: YOUR_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "templateId": "",
  "description": "Cash Flow Report Task",
  "historyDataExpiryDuration": "0:never_expire",
  "isActive": true,
  "task": {
    "taskType": "RptExport",
    "payload": "{\"isEmailBody\":false,\"parameters\":{},\"bursting\":null,\"settings\":{},\"exportFormat\":\"pdf\"}",
    "parameters": "{}",
    "documentId": "b1d3027c-f808-4a0b-b8d8-b398cc18631a"
  },
  "documentId": "b1d3027c-f808-4a0b-b8d8-b398cc18631a",
  "trigger": {
    "pattern": {
     "patterns": ["0 0 8 ? * MON,TUE,WED,THU,FRI *"],
     "startDate": "2026-04-04T05:00:00.627Z",
     "endDate": null,
     "timeZoneId": "Eastern Standard Time"}
  },
  "deployTo": {
    "emailAttach": {
      "settings": {
        "mailTo": ["enea.gega@wynenterprise.com", "experts@wynenterprise.com"],
        "subject": "Cash Flow Report",
        "body": "Please find the Cash Flow Report attached as a pdf document.",
        "bodyForEmptyDocument": "",
        "replyTo": "enea.gega@wynenterprise.com",
        "useRichText": false,
        "allowUserChangeEmailTo": false
      },
      "localStore": {
        "allowAnonymous": false,
        "storePolicy": {
          "forever": true
        }
      }
    }
  },
  "compoundTask": false
}'

This is an example of a successful (200) response:

curl --location 'http://localhost:51980/api/v2/scheduler/tasks' \
--header 'Reference-Token: YOUR_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "templateId": "",
  "description": "Cash Flow Report Task",
  "historyDataExpiryDuration": "0:never_expire",
  "isActive": true,
  "task": {
    "taskType": "RptExport",
    "payload": "{\"isEmailBody\":false,\"parameters\":{},\"bursting\":null,\"settings\":{},\"exportFormat\":\"pdf\"}",
    "parameters": "{}",
    "documentId": "b1d3027c-f808-4a0b-b8d8-b398cc18631a"
  },
  "documentId": "b1d3027c-f808-4a0b-b8d8-b398cc18631a",
  "trigger": {
    "pattern": {
     "patterns": ["0 0 8 ? * MON,TUE,WED,THU,FRI *"],
     "startDate": "2026-04-04T05:00:00.627Z",
     "endDate": null,
     "timeZoneId": "Eastern Standard Time"}
  },
  "deployTo": {
    "emailAttach": {
      "settings": {
        "mailTo": ["enea.gega@wynenterprise.com", "experts@wynenterprise.com"],
        "subject": "Cash Flow Report",
        "body": "Please find the Cash Flow Report attached as a pdf document.",
        "bodyForEmptyDocument": "",
        "replyTo": "enea.gega@wynenterprise.com",
        "useRichText": false,
        "allowUserChangeEmailTo": false
      },
      "localStore": {
        "allowAnonymous": false,
        "storePolicy": {
          "forever": true
        }
      }
    }
  },
  "compoundTask": false
}'

As shown in the screenshot below, the exporting task has been created and is scheduled to run every weekday at 08:00 Eastern Time. The Scheduled Task panel on the right displays the next run time as 6 April 2026 at 15:00. This reflects the time difference between my local time zone and Eastern Time

As shown in the screenshot below, the exporting task has been created and is scheduled to run every weekday at 08:00 Eastern Time. The Scheduled Task panel on the right displays the next run time as 6 April 2026 at 15:00. This reflects the time difference between my local time zone and Eastern Time

Here is the full list of object types that can be used in the request body: 

TaskInfo Object

TaskInfoArray Object 

UserDetails Object 

RunAs Object 

FailInformProvider Object 

Trigger Configuration Reference 

The trigger object determines when and how the task is executed. Set exactly one of the following fields:

Pattern (Recurring) Object 

Important: The time zone ID must match the server’s operating system. Windows servers use Windows time zone IDs (e.g., "Central European Standard Time"), not IANA IDs (e.g., "Europe/Berlin"). You can retrieve the list of supported time zones by running window.ServerTimeZones.map(a => a.id) in the browser console.

Delivery Target (deployTo) Reference 

The deployTo object specifies where the task output is delivered. Set exactly one of the following fields: