TRtrycompai
Tasks

Create compliance task

Changed on

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

post/v1/tasks

Request

  • Base URL
    https://api.trycomp.ai
  • Auth
    API key in header X-API-Key

Request body

titlestring required
descriptionstring required
assigneeIdstring nullable
frequency'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' nullable
departmentstring nullable

Built-in values: none, admin, gov, hr, it, itsm, qms. Custom department names are also accepted.

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

  • 33c685841b7aRevision changes
    • breaking

      removed the enum value admin of the request property

    • breaking

      removed the enum value gov of the request property

    • breaking

      removed the enum value hr of the request property

    • breaking

      removed the enum value it of the request property

    • breaking

      removed the enum value itsm of the request property

    • breaking

      removed the enum value none of the request property

    • breaking

      removed the enum value qms of the request property

    • warning

      the request property's maxLength was set to 64

  • 7ca7c363a732Revision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      added the new admin enum value to the request property

    • info

      added the new gov enum value to the request property

    • info

      added the new hr enum value to the request property

    • info

      added the new it enum value to the request property

    • info

      added the new itsm enum value to the request property

    • info

      added the new none enum value to the request property

    • info

      added the new qms enum value to the request property