CAZZ Docs

Appearance

Add tab ​

http
POST /api/workflow/{workspace_id}/workflow/{workflow_id}/tabs

Request Body ​

ts
type Tab = {
  name: string;
  content: string;
};

Response Body ​

ts
type TabResponse = {
  success: boolean;
  message: string;
  data: Data;
};

type Data = {
  tab_id: string;
  document_id: string;
  name: string;
  content: string;
  parent_tab_id: null;
  created_at: Date;
};

Get tabs ​

http
GET /api/workflow/{workflow_id}/workflow/{workflow_id}/tabs

Request Body ​

No body required

Response ​

ts
type TabResponse = {
  success: boolean;
  message: string;
  data: Data[];
};

type Data = {
  tab_id: string;
  document_id: string;
  name: string;
  content: string;
  parent_tab_id: null | string;
  created_at: Date;
  rank: number;
};

Update tab ​

http
PUT /api/workflow/{workspace_id}/workflow/{workflow_id}/tabs/{tab_id}

Request Body ​

ts
type Tab = {
  name?: string;
  content?: string;
  parent_tab_id?: string;
};

Response Body ​

ts
type TabResponse = {
  success: boolean;
  message: string;
  data: Data;
};

type Data = {
  tab_id: string;
  document_id: string;
  name: string;
  content: string;
  parent_tab_id: null;
  created_at: Date;
};

Delete tab ​

http
DELETE /api/workflow/{workspace_id}/workflow/{workflow_id}/tabs/{tab_id}

No body required

Response Body ​

ts
type TabResponse = {
  success: boolean;
  message: string;
};

Re-order tabs ​

http
PUT /api/workflow/{workflow_id}/{tab_id}/re-order

Request Body ​

ts
type reorderTabs = {
  fromIndex: number;
  toIndex: number;
};

Response ​

ts
type TabReorderResponse = {
  success: boolean;
  message: string;
};
http
POST /api/workflow/{workspace_id}/workflow/{workflow_id}/tabs/{tab_id}/links

Request Body ​

ts
type Link = {
  targetType: ["tab", "document"];
  targetId: string;
  displayName: string;
};

Response ​

ts
type LinkResponse = {
  success: boolean;
  message: string;
  data: Data;
};

type Data = {
  link_id: string;
  tab_id: string;
  target_type: string;
  target_id: string;
  display_name: string;
  created_at: Date;
};
http
GET /api/workflow/{workspace_id}/workflow/{workflow_id}/tabs/{tab_id}/links

No body required

Response ​

ts
type LinkResponse = {
  success: boolean;
  message: string;
  data: Data[];
};

type Data = {
  link_id: string;
  tab_id: string;
  target_type: string;
  target_id: string;
  display_name: string;
  created_at: Date;
};
http
GET /api/workflow/{workspace_id}/workflow/{workflow_id}/{link_id}/link-redirect

No body required

Response ​

ts
type RedirectResponse = {
  success: boolean;
  message: string;
  data: Data;
};

type Data = {
  tab_id: string;
  document_id: string;
  name: string;
  content: string;
  parent_tab_id: null;
  created_at: Date;
};
http
PUT /api/workflow/{workspace_id}/workflow/{workflow_id}/links/{link_id}

Request Body ​

ts
type UpdateLink = {
  targetType: string;
  targetId: string;
  displayName: string;
};

Response ​

ts
type UpdateResponse = {
  success: boolean;
  message: string;
  data: Data;
};

type Data = {
  link_id: string;
  tab_id: string;
  target_type: string;
  target_id: string;
  display_name: string;
  created_at: Date;
};
http
DELETE /api/workflow/{workspace_id}/workflow/{workflow_id}/links/{link_id}

No Body Required

Response ​

ts
type UpdateResponse = {
  success: boolean;
  message: string;
};