Timeline entries

Create Timeline Entry

Creates a new entry on an object's timeline.

POST
/timeline-entries.create

Creates a new entry on an object's timeline.

Authorization

auth-token

AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Request Body

application/json

type*string
Value in"timeline_comment"
expires_at?string

If set, then the entry is ephemeral and will be deleted after the provided time. The minimum value should be at least a minute more than the current timestamp.

Formatdate-time
object*string

The ID of the object to create the timeline entry for.

Formatid
private_to?array<string>

If the visibility of the entry is private, this specifies the users that the entry is private to. Note the creator is always implicitly included in this list.

visibility?string

The visibility of the entry. If 'private', then the entry is only visible to the creator, 'internal' is visible with the Dev organization, 'external' is visible to the Dev organzation and Rev users, and 'public' is visible to all. If not set, then the default visibility is 'external'.

Value in"external" | "internal" | "private" | "public"
artifacts?array<string>

The IDs of the artifacts attached to the comment.

Itemsitems <= 50
body?string

The comment's body.

Formattext
body_type?string

The type of the body to use for the comment.

Value in"data" | "snap_kit" | "snap_widget" | "text"
snap_kit_body?

Snap Kit Body of the comment.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.devrev.ai/timeline-entries.create" \  -H "Content-Type: application/json" \  -d '{    "type": "timeline_comment",    "object": "PROD-12345"  }'
{
  "timeline_entry": {
    "type": "timeline_comment",
    "created_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "created_date": "2023-01-01T12:00:00.000Z",
    "display_id": "string",
    "id": "string",
    "modified_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "modified_date": "2023-01-01T12:00:00.000Z",
    "object": "string",
    "object_display_id": "string",
    "object_type": "article",
    "visibility": "external",
    "artifacts": [
      {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      }
    ],
    "body": "string",
    "body_type": "data",
    "references": [
      {
        "type": "article",
        "display_id": "string",
        "id": "string",
        "article_type": "article",
        "resource": {
          "artifacts": [
            {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            }
          ],
          "url": "string"
        },
        "title": "string"
      }
    ],
    "snap_kit_body": {
      "body": {},
      "snap_in_action_name": "string",
      "snap_in_id": "string"
    },
    "snap_widget_body": [
      {
        "type": "string"
      }
    ]
  }
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "conflict"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}