Supported entity types for the AI Connector

The AI Connector supports 11 different entity types:

1. User (user)

User profiles and account information.

Key Fields:

  • id - User unique identifier

  • firstName, lastName, displayName - Name information

  • email - Email address

  • status - User status (ACTIVE, INACTIVE, HIDDEN, DELETED)

  • external - Boolean indicating external user

  • locale, timezone - User localization settings

  • groupIds - Array of group memberships

  • manager - Manager user ID

  • imageUrls - Avatar and cover images

  • properties - Custom user properties

  • createdDate, modifiedDate - Timestamps

  • target - Link target for user profile

  • initials, color - Display properties

Use Cases: User directory, org charts, people search, contact information

2. App (app)

Applications and modules within Haiilo (blogs, wikis, file libraries, etc.).

Key Fields:

  • id - App unique identifier

  • type - App type (blog, wiki, file-library, etc.)

  • name - Multilingual app name (map: locale → name)

  • textContent - Multilingual app description

  • imageAltText - Multilingual image alt text

  • active, enabled - Status flags

  • visibility - Visibility setting (PUBLIC, PRIVATE)

  • parentId - Parent app/container ID

  • context - Reference to owning workspace/page

  • defaultLanguage - Primary language code

  • settings - Custom app settings

  • createdDate, modifiedDate - Timestamps

  • target - Link target for the app

Use Cases: App discovery, content organization, navigation structure

3. Timeline Item (timeline-item)

Social posts, updates, and timeline entries.

Key Fields:

  • id - Timeline item unique identifier

  • itemType - Type of timeline item (POST, SHARE, etc.)

  • author, originalAuthorId - Author information

  • data - Content payload (text, media, etc.)

  • status - Item status (VISIBLE, HIDDEN)

  • recipientIds - Target audience user IDs

  • shares - Array of share objects

  • attachments - Array of attachment objects (images, files, etc.)

  • targetSegments - Target segment IDs

  • remoteReference - External system reference

  • createdDate, modifiedDate - Timestamps

Attachment Object:

  • contentType - MIME type

  • name - File name

  • metaData - File metadata (length, storage location, image dimensions)

Use Cases: Social feed content, activity streams, employee communications

4. Blog Article (blog-article)

Published blog articles and news posts.

Key Fields:

  • id - Article unique identifier

  • appId - Parent blog app ID

  • title - Multilingual title (map: locale → title)

  • textContent - Multilingual article content (HTML)

  • teaser - Multilingual teaser/summary text

  • imageAltText - Multilingual image alt text

  • published - Publication status

  • publishedDate - Publication timestamp

  • archiveDate - Archive timestamp (if archived)

  • commentsEnabled - Whether comments are allowed

  • teaserImage - Teaser image URLs by locale

  • teaserWidgetImage - Widget teaser image URLs

  • hashtags - Array of hashtag strings

  • author, originalAuthor - Author references

  • context - Reference to parent blog

  • defaultLanguage - Primary language

  • createdDate, modifiedDate - Timestamps

  • target - Link target for the article

Use Cases: Knowledge base, news feed, company announcements

5. Wiki Article (wiki-article)

Wiki pages and knowledge base articles.

Key Fields:

  • id - Article unique identifier

  • appId - Parent wiki app ID

  • parentId - Parent wiki article ID (for hierarchy)

  • title - Multilingual title

  • textContent - Multilingual article content (HTML)

  • imageAltText - Multilingual image alt text

  • draft - Draft status (true = unpublished)

  • defaultLanguage - Primary language

  • hashtags - Array of hashtag strings

  • author, originalAuthor - Author references

  • context - Reference to parent wiki

  • archiveDate - Archive timestamp (if archived)

  • createdDate, modifiedDate - Timestamps

  • target - Link target for the article

Use Cases: Documentation, how-to guides, knowledge management

6. Page (page)

Organizational pages (department pages, team pages, etc.).

Key Fields:

  • id - Page unique identifier

  • name - Multilingual page name

  • description - Multilingual page description

  • status - Page status (ACTIVE, DELETED)

  • visibility - Visibility setting (PUBLIC, PRIVATE)

  • defaultLanguage - Primary language

  • availableLanguages - Array of supported language codes

  • members, admins - User ID arrays

  • memberGroups, adminGroups - Group ID arrays

  • imageUrls - Page images (avatar, cover)

  • initials, color - Display properties

  • createdDate, modifiedDate - Timestamps

  • target - Link target for the page

Use Cases: Organizational structure, department information, team pages

7. Community (workspace)

Collaboration communities and group areas.

Key Fields:

  • id - Community unique identifier

  • name - Community name

  • description - Community description

  • status - Community status (ACTIVE, DELETED, ARCHIVED)

  • visibility - Visibility setting (PUBLIC, PROTECTED, PRIVATE)

  • defaultLanguage - Primary language

  • localeData - Map of locale-specific data (title, description per language)

  • members, admins - User ID arrays

  • imageUrls - Community images (avatar, cover)

  • initials, color - Display properties

  • createdDate, modifiedDate - Timestamps

  • target - Link target for the community

Use Cases: Project spaces, team collaboration areas, group content

8. Event (event)

Calendar events and meetings.

Key Fields:

  • id - Event unique identifier

  • name - Event name

  • description - Event description

  • place - Event location/venue

  • startDate, endDate - Local datetime values

  • startTimestamp, endTimestamp - Unix timestamps

  • timezone - Event timezone

  • creatorId, hostId - User IDs

  • attenderIds - Array of attendee user IDs

  • allInviteeIds - Array of all invited user IDs

  • status - Event status (ACTIVE, DELETED)

  • visibility - Visibility setting (PUBLIC, PRIVATE)

  • imageUrls - Event images (deprecated)

  • imageWebUrls - Web-optimized event images

  • initials, color - Display properties

  • target - Link target for the event

Use Cases: Event discovery, calendar integration, meeting scheduling

9. File (file)

Files and folders in file libraries.

Key Fields:

  • id - File unique identifier

  • name - File or folder name

  • folder - Boolean indicating if entry is a folder

  • description - File description

  • textContent - Extracted text content (for searchable files)

  • contentType - MIME type

  • length - File size in bytes

  • authorId - Creator user ID

  • appId - Parent file library app ID

  • parentId - Parent folder ID

  • context - Reference to parent container

  • currentVersionBlobReference - Reference to file storage

    • groupId - Storage group identifier

    • uid - Unique file identifier

    • contentType - MIME type

  • createdDate, modifiedDate - Timestamps

Use Cases: Document management, file indexing, content search

10. Comment (comment)

Comments on various content types.

Key Fields:

  • authorId - Comment author user ID

  • originalAuthorId - Original author (for shared comments)

  • targetId - ID of commented entity

  • targetType - Type of commented entity

  • parentCommentId - Parent comment ID (for threaded replies)

  • message - Comment text content

  • status - Comment status (VISIBLE, HIDDEN)

  • attachments - Array of attachment objects

  • createdDate, modifiedDate - Timestamps

Use Cases: Discussion threads, content feedback, engagement tracking

11. Target Segments (target-segments)

User targeting and audience segmentation information.

Key Fields:

  • id - Segment unique identifier

  • targetEntityId - ID of the targeted entity

  • targetType - Type of target (currently: PAGE)

  • userIds - Array of user IDs in this segment

Use Cases: Content targeting, audience management, personalization

Was this article helpful?

0 out of 0 found this helpful