Task

Fetch task

get/task/{taskId}/fetch

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/task/{taskId}/fetch
  • Auth: HTTP bearer

Path parameters

taskIdstring required

The ID of the task to retrieve

Response

The task was retrieved successfully

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

idstring required

The instance ID

createdAtnumber required

The timestamp (ms) when the instance was created

updatedAtnumber required

The timestamp (ms) when the instance was updated

blueprintIdstring

The blueprint associated with the task

contactIdstring

The contact associated with the task

botIdstring

The bot associated with the task

schedulestring

The schedule of the task

timezonestring nullable

The IANA timezone identifier used to evaluate the task schedule.

sessionDurationnumber nullable

The session duration of the task execution (in milliseconds)

maxIterationsnumber

The maximum number of iterations per task execution

maxTimenumber

The maximum time per task execution (in milliseconds)

status'idle' | 'running' | 'canceled'

The task execution status

outcome'pending' | 'success' | 'failure'

The task execution outcome

lastRunAtnumber nullable

The timestamp (ms) of the last task execution

nextRunAtnumber nullable

The timestamp (ms) of the next scheduled task execution

expiresAtnumber nullable

The timestamp (ms) at which the task expires and is automatically deleted

Changes

No recorded changes to this operation across all 1 revision of this API.