Type Alias ActivityMeta

ActivityMeta: { [key: string]: JSONValue }

Represents metadata about an activity, typically from an external system.

Activity metadata enables storing additional information about activities, which is useful for synchronization, linking back to external systems, and storing tool-specific data.

Must be valid JSON data (strings, numbers, booleans, null, objects, arrays). Functions and other non-JSON values are not supported.

Type Declaration

[key: string]: JSONValue
Source-specific properties and metadata

Example

// Calendar event metadata
await plot.createActivity({
  type: ActivityType.Event,
  title: "Team Meeting",
  start: new Date("2024-01-15T10:00:00Z"),
  meta: {
    calendarId: "primary",
    htmlLink: "https://calendar.google.com/event/abc123",
    conferenceData: { ... }
  }
});

// Project issue metadata
await plot.createActivity({
  type: ActivityType.Action,
  title: "Fix login bug",
  meta: {
    projectId: "TEAM",
    issueNumber: 123,
    url: "https://linear.app/team/issue/TEAM-123"
  }
});

Type Alias ActivityMeta

Type Declaration

[key: string]: JSONValue

Example

Settings