GuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussions API Change LogOpenAPI Specification Download
API Endpoints
Home
  1. Public API
  2. industries-workflows

Create a workflow schedule

post
https://api.talkdeskapp.com/industries/workflows/schedules

Creates a new schedule that will trigger the configured workflow on the given cron expression.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

industries-workflows:write

Body Params
string
required
length between 1 and 256

Name of the workflow implementation that will run on each scheduled execution.

string
required
length between 1 and 256

The task queue that will run the workflow.

string | null

Optional logical job name associated with this schedule.

string | null

Cron expression for the schedule. Either cron_expression or start_at must be provided.

date-time | null

Optional one-shot start time. Use this instead of cron_expression to fire the schedule a single time.

payload
object

Payload passed to the workflow on each execution.

tags
array of strings

Optional tags to apply to every workflow produced by the schedule.

tags
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?