Skip to main content

Conversation V2

Conversation V2 uses explicit Conversation and ConversationReply schemas for discussions attached to metadata entities and fields. Breaking change: Clients that used /v1/feed must migrate. Human conversations now use /v1/conversations. Announcements, tasks, and generated activity use /v1/announcements, /v1/tasks, and /v1/activity. Update old feed clients to the matching resource endpoint and response schema.

Endpoints

List Parameters

Reply listing uses before, after, and limit. Its default limit is 20 and its maximum is 100. The {reactionType} path parameter accepts thumbsUp, thumbsDown, hooray, laugh, confused, heart, rocket, or eyes. GET /v1/tasks and its per-status list endpoints accept q for free-text search. The match is case-insensitive and runs against the task name, display name, request reason, and the display name or fully qualified name of the entity the task is about. It searches the database, not the search index.

Create a Conversation

Send a POST request with message and about to create a conversation:
Both message and about are required. message is non-blank Markdown and about is an entity link.

Response Schemas

Conversation is the root schema. Its identity and source fields are id, source, and about. The resolved target appears in entityRef, with inherited domains in domains. Status fields cover timestamps, resolution state, and reply count. The schema can also include recent replies and reactions. User-created conversations contain the root message and createdBy. Activity-backed conversations identify the source event through activityEventId and activityTimestamp. ConversationReply identifies the reply, conversation, and author. It also contains the Markdown message, timestamps, and reactions. OpenMetadata stores replies separately and returns them through the reply endpoints.

Authorization

  • Listing requires ViewBasic on conversations. A request scoped with entityLink also requires ViewBasic on the target entity.
  • Creating a root conversation requires Create on conversations and ViewBasic on the target.
  • Reading a conversation requires ViewBasic on that conversation. OpenMetadata returns unauthorized direct reads as not found to avoid revealing the conversation’s existence.
  • Patching or deleting a conversation or reply requires the corresponding conversation permission evaluated against that resource. Editing message content is not implicitly allowed to every authenticated user.
  • Replying and reacting require permission to read the container and Create on conversations. Activity-backed conversations also require access to the activity target.
These checks replace the permissive behavior some callers encountered on the old feed API.

Task API Changes

Breaking change: Version 2.1 retires the legacy thread-task API. Tasks are Task entities served from /v1/tasks, and task state no longer lives on a feed thread.
  • Identifiers: Task IDs are universally unique identifiers (UUIDs). The numeric IDs that /v1/feed/tasks/{id} used no longer apply. The 2.0 migration kept each old thread’s UUID as the task UUID.
  • Thread schema: Thread.type accepts Conversation, Announcement, and Chatbot. It no longer accepts Task, and the Thread and CreateThread schemas no longer carry task details.
  • Request payloads: The feed close and resolve payload schemas (closeTask and resolveTask) are removed from the feed API.
  • Python SDK: Replace resolve_feed_task and close_feed_task with resolve_task and close_task.
  • Alert events: Task lifecycle notifications use entityCreated and entityUpdated with entityType=task. The taskCreated, taskUpdated, taskResolved, and taskClosed event values are no longer available.
  • Existing task threads: Task threads created through the feed task API while on 2.0.x aren’t migrated. They stay in the thread_entity_archived table.

Activity Feed Endpoints

Activity feed endpoints return recent activity events. Each one returns the caller’s own feed unless you pass userId.

Feed Parameters

All three feed endpoints accept the following query parameters. Each feed omits events about entities the caller cannot view, including when you pass userId.