Getting Started

Introducing the Comment Stream API

The Comment Stream REST API v1 lets integrators programmatically manage comments, replies, and reactions on Workfront and Adobe platform objects. Use it when you need a stable HTTP resource model for server-to-server integrations.

Before you begin

  1. Authentication — Set up Adobe IMS OAuth 2.0 credentials in Adobe Developer Console and learn required request headers.
  2. Error handling — Understand HTTP status codes and error response shapes.
  3. Limits — Review pagination caps, content size limits, and the author edit window.
  4. API Reference — Explore all endpoints interactively.

Base URL

External customer requests go through the Adobe I/O API Gateway once the service is onboarded (same pattern as other Workfront public APIs).

https://workfront.adobe.io/comment-stream/api/v1

data-variant=warning

data-slots=text
The gateway hostname above is illustrative until Adobe I/O onboarding assigns the production *.adobe.io URL. Do not use internal cluster hostnames in customer integrations.

Quick example — create a comment

curl -X POST "https://workfront.adobe.io/comment-stream/api/v1/comment" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "x-api-key: $API_KEY" \
  -H "x-gw-ims-org-id: $IMS_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "objectID": "6400cae3000c141416060e29",
    "objectCode": "PROJ",
    "content": "Kickoff notes are ready for review.",
    "contentHTML": "<p>Kickoff notes are ready for review.</p>",
    "isPrivate": false
  }'

A successful response (200 OK) returns a comment object including _id, objectID, objectCode, content, contentHTML, and audit fields.

Next steps

Head to the API Reference for the full endpoint catalog, or read the Authentication guide for token and header details.