Skip to content

Overview ​

Intake lets guests create work items that admins and members can review and move into a project.

Learn more about Intake

Enable Intake ​

To enable Intake, send a PATCH request to the project API with this body:

{
	intake_view:true,
}

To create an Intake work item, send a payload in this format:

json
{
  "issue": {
    "name": "Snoozed task 2",
    "priority": "high"
  }
}

The Intake object ​

Attributes ​

  • created_at timestamp

    When the project was created

  • updated_at timestamp

    When the project was last updated

  • status

    The work item's intake status. One of:

    • -2 - Pending
    • -1 - Rejected
    • 0 - Snoozed
    • 1 - Accepted
    • 2 - Duplicate
  • snoozed_till

    The time until which the work item is snoozed.

  • source

    The source the intake work item came from

  • created_by , updated_by uuid

    IDs of the users who created and last updated the module, set automatically

  • Project uuid

    ID of the project, set automatically.

  • Workspace uuid

    ID of the workspace, set automatically.

  • inbox

    ID of the intake the work item belongs to

  • issue

    ID of the work item

  • duplicate_to

    ID of the work item that this work item duplicates.

Response200
json
{
  "id": "0de4d6d1-fdc7-4849-8080-dc379ab210e3",
  "pending_issue_count": 0,
  "created_at": "2023-11-21T07:32:26.072634Z",
  "updated_at": "2023-11-21T07:32:26.072648Z",
  "name": "a dummy project with Intake",
  "description": "",
  "is_default": true,
  "view_props": {},
  "created_by": "0649cb9d-05c8-4ef4-8e8b-d108ccddd42c",
  "updated_by": "0649cb9d-05c8-4ef4-8e8b-d108ccddd42c",
  "project": "6436c4ae-fba7-45dc-ad4a-5440e17cb1b2",
  "workspace": "c467e125-59e3-44ec-b5ee-f9c1e138c611"
}