craft-hub / IntegrationEntity

Interface: IntegrationEntity

Defined in: packages/craft-hub/src/integrations.ts:175

Properties

ancestors?

optional ancestors?: Pick<IntegrationEntity, "title" | "metadata" | "id" | "sourceRef" | "url" | "status" | "statusLabel" | "statusCategory" | "archived">[]

Defined in: packages/craft-hub/src/integrations.ts:212

Root-to-parent context, independent of this item's status and the current result filters.

---

archived?

optional archived?: boolean

Defined in: packages/craft-hub/src/integrations.ts:196

Archived entities are excluded from unfinished work regardless of workflow status.

---

assignees?

optional assignees?: object[]

Defined in: packages/craft-hub/src/integrations.ts:201

Exact provider account identifiers; multi-assignee items include every current handler.

id

id: string

label?

optional label?: string

url?

optional url?: string

urlLabel?

optional urlLabel?: string

---

configurationToggle?

optional configurationToggle?: object

Defined in: packages/craft-hub/src/integrations.ts:176

enabled

enabled: boolean

inherited

inherited: boolean

revision

revision: string

scope

scope: "global" | "project"

---

description?

optional description?: string

Defined in: packages/craft-hub/src/integrations.ts:209

---

details?

optional details?: object[]

Defined in: packages/craft-hub/src/integrations.ts:214

Display-safe fields supplied by the provider, never raw configuration.

label

label: string

sourcePath?

optional sourcePath?: string

value

value: string

---

dueDate?

optional dueDate?: object

Defined in: packages/craft-hub/src/integrations.ts:183

Provider-local deadline and timezone, without host-local date conversion.

dateTime

dateTime: string

precision?

optional precision?: "date" | "datetime"

timeZone

timeZone: string = identitySchema

---

icon?

optional icon?: string

Defined in: packages/craft-hub/src/integrations.ts:192

Display icon as an isolated image URL or a host-supported semantic icon.

---

id

id: string

Defined in: packages/craft-hub/src/integrations.ts:177

---

important?

optional important?: boolean

Defined in: packages/craft-hub/src/integrations.ts:205

Provider-declared importance, independent of translated labels and presentation colors.

---

metadata?

optional metadata?: Record<string, string | number | boolean | null>

Defined in: packages/craft-hub/src/integrations.ts:210

---

personalMembership?

optional personalMembership?: object

Defined in: packages/craft-hub/src/integrations.ts:181

Explicit personal ownership or assignment, scoped to the authorized source account.

accountId

accountId: string = identitySchema

relation

relation: "unknown" | "owned" | "assigned"

---

priority?

optional priority?: object

Defined in: packages/craft-hub/src/integrations.ts:203

Provider-normalized presentation; native priority values remain in metadata.

label

label: string

tone?

optional tone?: "success" | "neutral" | "warning" | "danger" | "info"

---

project?

optional project?: object

Defined in: packages/craft-hub/src/integrations.ts:207

Provider-native project and item type, with display names for local classification.

id

id: string

title

title: string

---

reminderDate?

optional reminderDate?: object

Defined in: packages/craft-hub/src/integrations.ts:185

Enabled provider-local reminder and timezone; omitted when the source reminder is disabled.

dateTime

dateTime: string

precision?

optional precision?: "date" | "datetime"

timeZone

timeZone: string = identitySchema

---

sourceRef?

optional sourceRef?: object

Defined in: packages/craft-hub/src/integrations.ts:179

Stable provider identity, required for persisted project associations; absent on legacy providers.

accountId

accountId: string = identitySchema

containerId

containerId: string = identitySchema

instanceId

instanceId: string = identitySchema

itemId

itemId: string = identitySchema

kind

kind: string = identitySchema

providerId

providerId: string = identitySchema

---

status?

optional status?: string

Defined in: packages/craft-hub/src/integrations.ts:194

---

statusCategory?

optional statusCategory?: "open" | "done" | "unknown" | "resolved" | "closed" | "cancelled" | "planning" | "active" | "testing" | "review" | "releasing"

Defined in: packages/craft-hub/src/integrations.ts:199

---

statusLabel?

optional statusLabel?: string

Defined in: packages/craft-hub/src/integrations.ts:198

Display copy and semantic state; status remains the provider's native value for writes.

---

statusUpdateAvailable?

optional statusUpdateAvailable?: boolean

Defined in: packages/craft-hub/src/integrations.ts:189

Provider availability hint for this entity and request context; writes still require server authorization.

---

title

title: string

Defined in: packages/craft-hub/src/integrations.ts:190

---

type?

optional type?: object

Defined in: packages/craft-hub/src/integrations.ts:208

id

id: string

title

title: string

---

updatedAt?

optional updatedAt?: string

Defined in: packages/craft-hub/src/integrations.ts:187

Source modification time as an ISO instant with a UTC offset.

---

url?

optional url?: string

Defined in: packages/craft-hub/src/integrations.ts:193