JobRun

Add and modify job runs

ActionArguments

Container for action-specific arguments for a Job. The type field indicates which specific arguments field contains the data. Only one of the argument fields will be populated based on the action type.

Properties

Name	Type	Description	Restrictions
certApproverArgs	CertApproverArguments	Read-only certification generated approver action arguments.
certPhaseFinalizerArgs	CertPhaseFinalizerArguments	Read-only certification generated arguments for certificationPhaseFinalizerGenerated actions.
certSignerArgs	CertSignerArguments	Read-only certification generated signer action arguments.
certificationArgs	CertificationArguments	Input for certification actions.
contentRequestArgs	ContentRequestArguments	Input for contentRequest actions.
sendTaskArgs	SendTaskArguments	Input for sendTask actions.
type	string	The type of action the Job is performing. Dictates the type of arguments need to be passed to the Job.	required

Enumerated Values

Property	Value
type	sendTask
type	contentRequest
type	certificationApproverGenerated
type	certificationSignerGenerated
type	certificationConditionalApproverGenerated
type	certificationPhaseFinalizerGenerated
type	certification

Example

{
  "sendTaskArgs": {
    "assigneeUser": "user123",
    "document": "doc789",
    "title": "Review Q4 financial report"
  },
  "type": "sendTask"
}

ActionMetadata

Read-only action specific metadata associated with a JobRun.

Properties

Name	Type	Description	Restrictions
certApproverMetadata	CertificationApproverActionMetadata	Read-only metadata for a certification approver action. Contains information about who approved the certification and inherits task execution details from the parent TaskMetadata.
certConditionalApproverMetadata	CertificationConditionalApproverActionMetadata	Read-only metadata for the certification generated conditional approver action.
certSignerMetadata	CertificationSignerActionMetadata	Read-only metadata about an individual certification signer action.
certificationMetadata	CertificationGeneratorActionMetadata	Read-only metadata for a Certification action.
contentRequestMetadata	ContentRequestMetadata	Read-only metadata about a “content request” action.
sendTaskMetadata	SendTaskMetadata	Read-only metadata about a “send task” action.
type	string	The type of action the Job is performing. Dictates the type of arguments need to be passed to the Job.

Enumerated Values

Property	Value
type	sendTask
type	contentRequest
type	certificationApproverGenerated
type	certificationSignerGenerated
type	certificationConditionalApproverGenerated
type	certificationPhaseFinalizerGenerated
type	certification

Example

{
  "sendTaskMetadata": {
    "cancelCleanupComplete": false,
    "newApproverModifyEmailSent": false,
    "newAssigneeModifyEmailSent": false,
    "permalink": "https://app.wdesk.com/tasks/task-456",
    "previousApproverModifyEmailSent": false,
    "previousAssigneeModifyEmailSent": false,
    "status": "waiting",
    "task": "task-456",
    "taskCancelled": false,
    "taskCancelledNotificationSent": false,
    "taskModificationComplete": false
  },
  "type": "sendTask"
}

CertApproverArguments

Read-only certification generated approver action arguments.

Properties

Name	Type	Description	Restrictions
participants	[Participant]	List of participants involved in this certification approver action. These are the users who are responsible for approving the certification after it has been signed.

Example

{
  "participants": [
    {
      "id": "approver123",
      "type": "user"
    }
  ]
}

CertPhaseFinalizerArguments

Read-only certification generated arguments for certificationPhaseFinalizerGenerated actions.

Properties

Name	Type	Description	Restrictions
certPhaseBeingFinalized	string	The phase of certification that is being finalized.	required

Enumerated Values

Property	Value
certPhaseBeingFinalized	signing
certPhaseBeingFinalized	approval

Example

{
  "certPhaseBeingFinalized": "signing"
}

CertSignerArguments

Read-only certification generated signer action arguments.

Properties

Name	Type	Description	Restrictions
participants	[Participant]	List of participants involved in this certification signer action. These are the users who are responsible for signing and completing the certification.

Example

{
  "participants": [
    {
      "id": "signer123",
      "type": "user"
    }
  ]
}

CertificationApproverActionMetadata

Read-only metadata for a certification approver action. Contains information about who approved the certification and inherits task execution details from the parent TaskMetadata.

Properties

Name	Type	Description	Restrictions
approvedByUser	string	User id for user who approved this approver job.	Maximum length: 36
assigneeCompletedDate	string(date-time)	The date and time the task moved into “awaiting approval” status.
awaitingApprovalEventUser	string	The user id of the user who caused the task to move into “awaiting approval” status.
completedDate	string(date-time)	The date and time the task associated with this action was approved, completed or cancelled.
created	Action	When the action was performed, and details about the user who did it.
permalink	string	A stable URL that links to the created task.
sourceUrl	string	The URL of a wDesk resource that is associated with this task.
status	string	The status of the task associated with this action.
task	string	The id of the created task associated with this action.
taskCancelled	boolean	Whether the associated task with this action has been canceled.	required

Example

{
  "approvedByUser": "userId2342",
  "cancelCleanupComplete": false,
  "newApproverModifyEmailSent": false,
  "newAssigneeModifyEmailSent": false,
  "previousApproverModifyEmailSent": false,
  "previousAssigneeModifyEmailSent": false,
  "taskCancelled": false,
  "taskCancelledNotificationSent": false,
  "taskModificationComplete": false
}

CertificationArguments

Input for certification actions.

Properties

Name	Type	Description	Restrictions
approverScheduledReminderData	ReminderData	Configuration for reminder emails that will be sent to participants about incomplete tasks. Supports multiple reminder modes including system defaults, process defaults, custom schedules, or no reminders.
approversDueDate	string(date)	The due date for approvers to complete their approval tasks. This applies to all approval steps that occur after signing steps in the certification workflow.
assigneeScheduledReminderData	ReminderData	Configuration for reminder emails that will be sent to participants about incomplete tasks. Supports multiple reminder modes including system defaults, process defaults, custom schedules, or no reminders.
assigneesDueDate	string(date)	The due date for signers (assignees) to complete their portion of the certification. This applies to all signing steps in the certification workflow.
instructions	string	Detailed instructions for participants explaining what needs to be certified and any specific guidance for completing the certification.	Maximum length: 2000, Minimum length: 0
notificationSignerMessage	string	Custom message body for email notifications sent to signers. If not provided, a default message will be used.	Maximum length: 5000, Minimum length: 0
notificationSignerSubject	string	Custom subject line for email notifications sent to signers. If not provided, a default subject will be used.	Maximum length: 1000, Minimum length: 0
sourceLetter	string	The id of the source letter template to use for this certification. This letter contains the questions and structure that signers will respond to during the certification process.	Maximum length: 32, Minimum length: 0
steps	[CertificationStep]	The certification steps that define the workflow. Each step contains participants who will either sign or approve the certification. Steps are executed in the order they are defined.
title	string	The title of the certification that will be displayed to participants.	Maximum length: 500, Minimum length: 0

Example

{
  "sourceLetter": "letter-template-789abc",
  "steps": [
    {
      "completionMode": "all",
      "participants": [
        {
          "id": "signer123",
          "type": "user"
        }
      ],
      "type": "signer"
    }
  ],
  "title": "Q4 2024 Certification"
}

CertificationConditionalApproverActionMetadata

Read-only metadata for the certification generated conditional approver action.

Properties

Name	Type	Description	Restrictions
approvedByUser	string¦null	The id of the user who approved this conditional approver step allowing the certification to be signed.	Maximum length: 36
assigneeCompletedDate	string(date-time)	The date and time the task moved into “awaiting approval” status.
awaitingApprovalEventUser	string	The user id of the user who caused the task to move into “awaiting approval” status.
completedDate	string(date-time)	The date and time the task associated with this action was approved, completed or cancelled.
conditionalApprover	Participant	A participant, currently only users allowed.
created	Action	When the action was performed, and details about the user who did it.
effectiveStatus	string	Translates “Created” status into “Awaiting Approval”.
permalink	string	A stable URL that links to the created task.
sourceUrl	string	The URL of a wDesk resource that is associated with this task.
status	string	The status of the task associated with this action.
task	string	The id of the created task associated with this action.
taskCancelled	boolean	Whether the associated task with this action has been canceled.	required

Example

{
  "cancelCleanupComplete": false,
  "conditionalApprover": {
    "id": "user2342",
    "type": "user"
  },
  "newApproverModifyEmailSent": false,
  "newAssigneeModifyEmailSent": false,
  "previousApproverModifyEmailSent": false,
  "previousAssigneeModifyEmailSent": false,
  "taskCancelled": false,
  "taskCancelledNotificationSent": false,
  "taskModificationComplete": false
}

CertificationGeneratorActionMetadata

Read-only metadata for a Certification action.

Properties

Name	Type	Description	Restrictions
finalLetterSubmission	string	The id of the final letter submission. All the signers submitted responses for a certification get stored in a final letter submission. While individuals are working on their own submission, that is their own personal letter submission until they decide to submit it, at which time their answers get stored into the final letter submission.	Maximum length: 32
letterInstance	string	The id of the certification letter instance associated with this certification action. The letter instance, is the instantiation of the source letter chosen for this certification. Many certifications can share the same source letter, but each certification gets their own letter instance which stores their responses and status.	Maximum length: 32

Example

{
  "finalLetterSubmission": "finalLetterSubmissionId32342",
  "letterInstance": "letterInstanceId23423"
}

CertificationSignerActionMetadata

Read-only metadata about an individual certification signer action.

Properties

Name	Type	Description	Restrictions
assigneeCompletedDate	string(date-time)	The date and time the task moved into “awaiting approval” status.
awaitingApprovalEventUser	string	The user id of the user who caused the task to move into “awaiting approval” status.
completedDate	string(date-time)	The date and time the task associated with this action was approved, completed or cancelled.
created	Action	When the action was performed, and details about the user who did it.
markAsSignedExplanationNote	string¦null	If this certification signer action was “marked as signed” meaning someone signed on behalf of the actual assignee, this will contain the certification note id that links to that signer’s explanation as to why they marked this certification signed for another user.
permalink	string	A stable URL that links to the created task.
signature	string¦null	What the user who signed this certification signed as.
signerUser	string¦null	User id for user that signed this signer action.
sourceUrl	string	The URL of a wDesk resource that is associated with this task.
status	string	The status of the task associated with this action.
task	string	The id of the created task associated with this action.
taskCancelled	boolean	Whether the associated task with this action has been canceled.	required

Example

{
  "cancelCleanupComplete": false,
  "markAsSignedExplanationNote": "explanationNoteId",
  "newApproverModifyEmailSent": false,
  "newAssigneeModifyEmailSent": false,
  "previousApproverModifyEmailSent": false,
  "previousAssigneeModifyEmailSent": false,
  "signature": "John Signer",
  "signerUser": "signerUserId",
  "taskCancelled": false,
  "taskCancelledNotificationSent": false,
  "taskModificationComplete": false
}

CertificationStep

A single step in a certification workflow that defines who needs to participate and how the step should be completed. Steps are executed in sequence according to their order in the certification.

Properties

Name	Type	Description	Restrictions
completionMode	string	The completion mode that determines how many participants need to complete the step for it to be considered done. For example, all participants, or a single participant.
participants	[Participant]	List of participants who are responsible for completing this certification step. The participants will either sign or approve depending on the step type.
type	string	The type of certification step, which determines the action participants need to take. Can be either ‘signer’ or ‘approver’.

Enumerated Values

Property	Value
completionMode	one
completionMode	all
type	approver
type	signer

Example

{
  "completionMode": "all",
  "participants": [
    {
      "id": "user123",
      "type": "user"
    }
  ],
  "type": "signer"
}

ContentRequestArguments

Input for contentRequest actions.

Properties

Name	Type	Description	Restrictions
approver	Participant	A participant, currently only users allowed.
approverDueDate	string(date)	The due date by which the approver must review and approve the content. This applies after the assignee has completed their portion.
approverScheduledReminderData	ReminderData	Configuration for reminder emails that will be sent to participants about incomplete tasks. Supports multiple reminder modes including system defaults, process defaults, custom schedules, or no reminders.
assignee	Participant	A participant, currently only users allowed.
assigneeScheduledReminderData	ReminderData	Configuration for reminder emails that will be sent to participants about incomplete tasks. Supports multiple reminder modes including system defaults, process defaults, custom schedules, or no reminders.
document	string	The document id where the content is being requested. The assignee will receive edit permissions to this document to provide the requested content.
dueDate	string(date)	The due date by which the assignee must provide the requested content. This is when the assignee’s task portion should be completed.
instructions	string	Detailed instructions explaining what content is being requested and any specific guidance for completing the request.
section	string	The specific section id within the document where content is being requested. If provided, permissions will be scoped to this section. If not provided, permissions apply to the entire document.
title	string	The title of the content request that will be displayed to the assignee and approver.

Example

{
  "approver": {
    "id": "manager456",
    "type": "user"
  },
  "assignee": {
    "id": "user123",
    "type": "user"
  },
  "document": "doc789",
  "dueDate": "2024-12-15",
  "title": "Review financial statement"
}

ContentRequestMetadata

Read-only metadata about a “content request” action.

Properties

Name	Type	Description	Restrictions
assigneeCompletedDate	string(date-time)	The date and time the task moved into “awaiting approval” status.
awaitingApprovalEventUser	string	The user id of the user who caused the task to move into “awaiting approval” status.
completedDate	string(date-time)	The date and time the task associated with this action was approved, completed or cancelled.
created	Action	When the action was performed, and details about the user who did it.
permalink	string	A stable URL that links to the created task.
sourceUrl	string	The URL of a wDesk resource that is associated with this task.
status	string	The status of the task associated with this action.
task	string	The id of the created task associated with this action.
taskCancelled	boolean	Whether the associated task with this action has been canceled.	required

Example

{
  "cancelCleanupComplete": false,
  "newApproverModifyEmailSent": false,
  "newAssigneeModifyEmailSent": false,
  "permalink": "https://app.wdesk.com/tasks/task-456",
  "previousApproverModifyEmailSent": false,
  "previousAssigneeModifyEmailSent": false,
  "status": "waiting",
  "task": "task-456",
  "taskCancelled": false,
  "taskCancelledNotificationSent": false,
  "taskModificationComplete": false
}

JobRun

An instantiation of a Job created when a Process is started or when a new action is added to a running Process. An action’s implementation can be carried out by multiple JobRuns that make up a single action’s implementation. A JobRun’s action type is dictated by the type of “arguments” that are passed to it. The arguments are action specific.

Properties

Name	Type	Description	Restrictions
action	string	The type of action the Job is performing. Dictates the type of arguments need to be passed to the Job.
actionStatus	string	An action specific status. Actions can define their own set of statuses that vary from the more general orchestration status contained by the “status” field.
arguments	ActionArguments	Container for action-specific arguments for a Job. The type field indicates which specific arguments field contains the data. Only one of the argument fields will be populated based on the action type.
certExceptionResponseSelected	boolean	(Certifications only), If present, indicates whether an exceptional response has been selected for a question in the job.
certExplanationPresent	boolean	(Certifications only), If present, indicates whether an explanational is present for a question in the job.
created	Action	When the action was performed, and details about the user who did it.
eligibleToStart	boolean¦null	If present, indicates whether start can be called on this JobRun.
errorCode	string¦null	An error code, representing the reason why a JobRun was moved into ERROR or ERROR_HOLD state.
generated	ProcessGroupRun	A run-time grouping of JobRuns and other GroupRuns.
id	string	The JobRun’s unique identifier.
job	string¦null	The id of the Process Job this JobRun was created from.
lastReminder	LastReminder	Information about the most recent reminder that was sent for a task. Contains the timestamp of when the reminder was sent and the role of the recipient who received it.
metadata	ActionMetadata	Read-only action specific metadata associated with a JobRun.
modified	Action	When the action was performed, and details about the user who did it.
nextReminder	NextReminder	Information about the next scheduled reminder for a task. Contains the date when the next reminder will be sent and the role of the recipient who will receive it.
ordinal	integer(int32)	The zero-based index representing the location of this JobRun within its parent Group
parent	string¦null	The id of this JobRun’s parent. Not present if the parent is the root group of the Process.
readOnly	boolean	Whether this JobRun is read-only.
revision	integer(int64)	The revision number of the current representation of the JobRun.
runStarted	string(date-time)¦null	The time when this JobRun was started
status	string	The general execution status of the JobRun. The same set of statuses apply to all JobRuns. For action specific statuses see a JobRun’s action status.
tags	[TagLink]	The tag link, category, and value information associated with this Job.	unique
triggerType	string¦null	What triggers a group child to execute.

Enumerated Values

Property	Value
action	sendTask
action	contentRequest
action	certificationApproverGenerated
action	certificationSignerGenerated
action	certificationConditionalApproverGenerated
action	certificationPhaseFinalizerGenerated
action	certification
status	waiting
status	running
status	cancelling
status	complete
status	cancelled
status	error
status	errorHold
triggerType	whenEligible
triggerType	manual

Example

{
  "job-instance-1": {
    "id": "job-instance-1",
    "status": "complete"
  },
  "job-instance-2": {
    "id": "job-instance-2",
    "status": "running"
  }
}

LastReminder

Information about the most recent reminder that was sent for a task. Contains the timestamp of when the reminder was sent and the role of the recipient who received it.

Properties

Name	Type	Description	Restrictions
recipientRole	string	The role of the recipient for reminder notifications.
sent	string(date-time)	Timestamp of when the last reminder was sent.

Enumerated Values

Property	Value
recipientRole	assignee
recipientRole	approver

Example

{
  "recipientRole": "approver",
  "sent": "2024-01-14T09:00:00Z"
}

NextReminder

Information about the next scheduled reminder for a task. Contains the date when the next reminder will be sent and the role of the recipient who will receive it.

Properties

Name	Type	Description	Restrictions
date	string(date)	Date that the next reminder will be sent.
recipientRole	string	The role of the recipient for reminder notifications.

Enumerated Values

Property	Value
recipientRole	assignee
recipientRole	approver

Example

{
  "date": "2024-03-28",
  "recipientRole": "assignee"
}

Participant

A participant, currently only users allowed.

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of the participant. For user participants, this is the user id.	required, Maximum length: 36, Minimum length: 1
type	string	The type of participant.	required

Enumerated Values

Property	Value
type	user

Example

{
  "id": "userId1231231",
  "type": "user"
}

ReminderConfig

A single reminder configuration pairing a schedule (when to send) with notification details (subject and body content) for reminder emails.

Properties

Name	Type	Description	Restrictions
reminder	ReminderNotificationData	The notification content for a reminder email. Defines the subject line and body text that will be included in reminder emails sent to task participants.
schedule	ReminderSchedule	The type specified dictates which corresponding ReminderSchedule sibling field will be populated.

Example

{
  "reminder": {
    "body": "Please complete your assigned task by the due date.",
    "subject": "Reminder: Task due soon"
  },
  "schedule": {
    "relativeSchedule": {
      "offsets": [
        "P1D",
        "P3D"
      ],
      "time": "09:00:00",
      "timezone": "America/New_York"
    },
    "type": "relative"
  }
}

ReminderData

Configuration for reminder emails that will be sent to participants about incomplete tasks. Supports multiple reminder modes including system defaults, process defaults, custom schedules, or no reminders.

Properties

Name	Type	Description	Restrictions
mode	string	The mode that determines which reminder strategy to use for sending task reminder emails.
scheduledReminders	[ReminderConfig]¦null	List of custom reminder configurations defining when and how reminder emails should be sent. Only used when mode is set to custom. Each configuration specifies a schedule and notification details.	Minimum items: 0, Maximum items: 3

Enumerated Values

Property	Value
mode	none
mode	custom
mode	default
mode	processDefault

Example

{
  "mode": "default"
}

ReminderDateRange

Defines a date range for sending reminders with optional day-of-week filtering. Specifies when reminders should start and stop being sent, and optionally restricts reminders to specific days of the week within that range.

Properties

Name	Type	Description	Restrictions
days	[string]¦null	Days of the week between the start and end date range that reminder will be sent.	unique
end	string(date)	Reminders will stop being sent after this date.	required
start	string(date)	Start date (inclusive) that reminders will start being sent.	required

Example

{
  "days": [
    "monday",
    "wednesday",
    "friday"
  ],
  "end": "2024-01-31",
  "start": "2024-01-15"
}

ReminderNotificationData

The notification content for a reminder email. Defines the subject line and body text that will be included in reminder emails sent to task participants.

Properties

Name	Type	Description	Restrictions
body	string	The body content for the reminder email. This is the main message text that provides details about the task and what action is needed.	required, Maximum length: 5000, Minimum length: 0
subject	string	The subject line for the reminder email. This appears in the email subject and should clearly indicate the purpose of the reminder. A required field.	required, Maximum length: 1000, Minimum length: 0

Example

{
  "body": "Please complete your assigned task by the due date.",
  "subject": "Reminder: Task due soon"
}

ReminderRelativeRange

ISO-8601 duration relative to a due date for when a reminder will start and stop being sent as long as the associated task is “incomplete”.

Properties

Name	Type	Description	Restrictions
end	string	The ISO 8601 duration (relative to the due date) to stop sending reminders
start	string	The ISO 8601 duration (relative to the due date) to start sending a reminder

Example

{
  "end": "P0D",
  "start": "-P3D"
}

ReminderSchedule

The type specified dictates which corresponding ReminderSchedule sibling field will be populated.

Properties

Name	Type	Description	Restrictions
absoluteSchedule	ReminderScheduleAbsolute	Reminder schedule that sends reminders on specific absolute dates at a configured time. Defines an exact set of dates when reminders should be sent, along with the time and timezone for sending. Useful for scheduling reminders on predetermined calendar dates.
rangeSchedule	ReminderScheduleRange	Reminder schedule that configures reminders be sent from a start to an end date while the associated work remains incomplete.
relativeRangeSchedule	ReminderScheduleRelativeRange	Reminder schedule that sends reminders throughout a range relative to the associated due date at the specified time while the associated task is incomplete.
relativeSchedule	ReminderScheduleRelative	Reminder schedule that sends reminders relative to the associated due date based on provided offsets which are ISO-8601 durations that must be evenly divisible by a day.
type	string	Indicates the type of reminder schedule being used in the ReminderSchedule payload.	required

Enumerated Values

Property	Value
type	relativeRange
type	absolute
type	range
type	relative

Example

{
  "relativeSchedule": {
    "offsets": [
      "P1D",
      "P3D"
    ],
    "time": "09:00:00",
    "timezone": "America/New_York"
  },
  "type": "relative"
}

ReminderScheduleAbsolute

Reminder schedule that sends reminders on specific absolute dates at a configured time. Defines an exact set of dates when reminders should be sent, along with the time and timezone for sending. Useful for scheduling reminders on predetermined calendar dates.

Properties

Name	Type	Description	Restrictions
dates	[string]	Specific dates on which reminders will be sent at the configured time in the specified timezone. At least one date must be provided.	required, Minimum items: 1, unique
time	string	Time in the specified timezone that reminders will be sent each day.
timezone	string	Timezone for the time specified that reminders will be sent out each day.

Example

{
  "dates": [
    "2024-12-10",
    "2024-12-13",
    "2024-12-14"
  ],
  "time": "09:00:00",
  "timezone": "America/New_York"
}

ReminderScheduleRange

Reminder schedule that configures reminders be sent from a start to an end date while the associated work remains incomplete.

Properties

Name	Type	Description	Restrictions
range	ReminderDateRange	Defines a date range for sending reminders with optional day-of-week filtering. Specifies when reminders should start and stop being sent, and optionally restricts reminders to specific days of the week within that range.	required
time	string	Time in the specified timezone that reminders will be sent each day.	required
timezone	string	Timezone for the time specified that reminders will be sent out each day. If not specified defaults to UTC.

Example

{
  "range": {
    "days": [
      "monday",
      "wednesday",
      "friday"
    ],
    "end": "2024-01-31",
    "start": "2024-01-15"
  },
  "time": "09:00:00",
  "timezone": "America/New_York"
}

ReminderScheduleRelative

Reminder schedule that sends reminders relative to the associated due date based on provided offsets which are ISO-8601 durations that must be evenly divisible by a day.

Properties

Name	Type	Description	Restrictions
offsets	[string]	Offsets from the associated due date that a reminder will be sent. Duration amount specified must be evenly divisible by days.	required, Minimum items: 1, unique
time	string	Time in the specified timezone that reminders will be sent each day.	required
timezone	string	Timezone for the time specified that reminders will be sent out each day. If not specified defaults to UTC.

Example

{
  "offsets": [
    "-P3D",
    "-P1D",
    "P0D"
  ],
  "time": "09:00:00",
  "timezone": "America/New_York"
}

ReminderScheduleRelativeRange

Reminder schedule that sends reminders throughout a range relative to the associated due date at the specified time while the associated task is incomplete.

Properties

Name	Type	Description	Restrictions
relativeRange	ReminderRelativeRange	ISO-8601 duration relative to a due date for when a reminder will start and stop being sent as long as the associated task is “incomplete”.
time	string	Time in the specified timezone that reminders will be sent each day.
timezone	string	Timezone for the time specified that reminders will be sent out each day.

Example

{
  "relativeRange": {
    "end": "P0D",
    "start": "-P3D"
  },
  "time": "17:33:00",
  "timezone": "UTC"
}

SendTaskArguments

Input for sendTask actions.

Properties

Name	Type	Description	Restrictions
approver	Participant	A participant, currently only users allowed.
approverDueDate	string(date)¦null	The date when the approver’s review and approval is due. This is typically set after the assignee’s due date to allow time for approval after completion.
approverScheduledReminderData	ReminderData	Configuration for reminder emails that will be sent to participants about incomplete tasks. Supports multiple reminder modes including system defaults, process defaults, custom schedules, or no reminders.
assignee	Participant	A participant, currently only users allowed.
assigneeScheduledReminderData	ReminderData	Configuration for reminder emails that will be sent to participants about incomplete tasks. Supports multiple reminder modes including system defaults, process defaults, custom schedules, or no reminders.
document	string¦null	The id of the wDesk document associated with this task. This document is where the task work should be performed or reviewed.
dueDate	string(date)¦null	The date when the assignee’s portion of the task is due. The assignee is expected to complete their work by this deadline.
instructions	string¦null	Detailed instructions for the task assignee describing what work needs to be completed. This field is optional and can provide additional context beyond the title.	Maximum length: 2000, Minimum length: 0
section	string¦null	The id of the specific section within the document where the task work should be focused. This field is optional and helps direct the assignee and approver to the relevant part of the document. If a value for the section field is provided, a value for document field must also be provided.
title	string¦null	The title of the task that will be displayed to both the assignee and approver. This should be a concise summary of what needs to be done. A value for this field is required before an action with these arguments can be started.

Example

{
  "approver": {
    "id": "manager456",
    "type": "user"
  },
  "assignee": {
    "id": "user123",
    "type": "user"
  },
  "document": "doc789",
  "dueDate": "2024-12-15",
  "title": "Complete risk assessment"
}

SendTaskMetadata

Read-only metadata about a “send task” action.

Properties

Name	Type	Description	Restrictions
assigneeCompletedDate	string(date-time)	The date and time the task moved into “awaiting approval” status.
awaitingApprovalEventUser	string	The user id of the user who caused the task to move into “awaiting approval” status.
completedDate	string(date-time)	The date and time the task associated with this action was approved, completed or cancelled.
created	Action	When the action was performed, and details about the user who did it.
permalink	string	A stable URL that links to the created task.
sourceUrl	string	The URL of a wDesk resource that is associated with this task.
status	string	The status of the task associated with this action.
task	string	The id of the created task associated with this action.
taskCancelled	boolean	Whether the associated task with this action has been canceled.	required

Example

{
  "cancelCleanupComplete": false,
  "newApproverModifyEmailSent": false,
  "newAssigneeModifyEmailSent": false,
  "permalink": "https://app.wdesk.com/tasks/task-456",
  "previousApproverModifyEmailSent": false,
  "previousAssigneeModifyEmailSent": false,
  "status": "waiting",
  "task": "task-456",
  "taskCancelled": false,
  "taskCancelledNotificationSent": false,
  "taskModificationComplete": false
}

TagCategory

Tag category. Organizes a collection of tags.

Properties

Name	Type	Description	Restrictions
color	string	The color of this tag category	Maximum length: 32
id	string	The id of the tag category	Maximum length: 32
name	string	The name of the tag category	Maximum length: 255

Example

{
  "color": "#FF5733",
  "id": "category-456",
  "name": "Department"
}

TagLink

Represents a tag association linking a category and value to a specific entity. Tag links allow for flexible metadata categorization of Jobs, JobRuns, and other Process entities. Each link connects a target entity to a specific tag category-value pair.

Properties

Name	Type	Description	Restrictions
category	TagCategory	Tag category. Organizes a collection of tags.	required
id	string	The id of the tag link.	required, Maximum length: 32
target	string	The id of the target entity associated with this tag.	required
targetType	string	The target type for a tag. What this tag is describing.	required
value	TagValue	Tag value response.	required

Enumerated Values

Property	Value
targetType	job
targetType	jobRun

Example

{
  "category": {
    "color": "#FF5733",
    "id": "category-456",
    "name": "Department"
  },
  "id": "taglinkid234234",
  "target": "jobId1231231",
  "targetType": "job",
  "value": {
    "category": "category-456",
    "id": "value-789",
    "value": "Finance"
  }
}

TagValue

Tag value response.

Properties

Name	Type	Description	Restrictions
category	string	The id of the tag category that this value is associated with.	Maximum length: 32
id	string	The id of the tag value.	Maximum length: 32
value	string	The value held by this tag value.	Maximum length: 255

Example

{
  "category": "category-456",
  "id": "value-789",
  "value": "Finance"
}