Sign in
Tasks

Create compliance task

Create a compliance task for evidence collection, remediation, review, or recurring control work inside an organization.

post/v1/tasks

Request body

titlestring required
descriptionstring required
assigneeIdstring nullable
frequency'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' nullable
department'none' | 'admin' | 'gov' | 'hr' | 'it' | 'itsm' | 'qms' nullable
controlIdsstring[]
taskTemplateIdstring nullable
vendorIdstring nullable

Vendor ID to connect this task to

Example request

{
  "title": "Implement access controls",
  "description": "Set up role-based access controls for the platform",
  "assigneeId": "mem_abc123",
  "frequency": "monthly",
  "department": "it",
  "controlIds": [
    "ctrl_abc123"
  ],
  "taskTemplateId": "tmpl_abc123",
  "vendorId": "vnd_abc123"
}

Response

Task created successfully

idstring required

Unique identifier for the task

titlestring required

Task title

descriptionstring

Task description

status'todo' | 'in_progress' | 'done' | 'blocked' required

Task status

createdAtstring date-time required

Task creation timestamp

updatedAtstring date-time required

Task last update timestamp

taskTemplateIdobject nullable

Task template ID

integrationScheduleFrequency'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' required

Cadence for running the integration check attached to this task

integrationLastRunAtobject nullable

Last successful integration check run timestamp

Example response

{
  "id": "tsk_abc123def456",
  "title": "Implement user authentication",
  "description": "Add OAuth 2.0 authentication to the platform",
  "status": "in_progress",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "integrationScheduleFrequency": "daily"
}

Changes

Changed in 2 of the 51 revisions of this API.3

  • 36253e8a5c1b2See the full diff
    • ○

      added the optional property integrationLastRunAt to the response with the 201 status

      response-optional-property-added

    • ○

      added the required property integrationScheduleFrequency to the response with the 201 status

      response-required-property-added

  • 946edaa856a91See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog