Create Timeline Entry
Creates a new entry on an object's timeline.
Creates a new entry on an object's timeline.
Authorization
auth-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
"timeline_comment"The collection(s) that the entry belongs to, otherwise if not provided, then the entry's default collection is used.
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.
date-timeThe labels to be associated with the entry.
1 <= length <= 64items <= 16The ID of the object to create the timeline entry for.
idIf 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.
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'.
"external" | "internal" | "private" | "public"The IDs of the artifacts attached to the comment.
items <= 50The comment's body.
textThe type of the body to use for the comment.
"data" | "snap_kit" | "snap_widget" | "text"The external reference for the comment. This must be unique within the object's timeline.
text1 <= length <= 512The IDs of the previews of the links posted in the comment.
Snap Kit Body of the comment.
The snap widget 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_change_event",
"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",
"external_ref": "string",
"labels": [
"string"
],
"object": "string",
"object_display_id": "string",
"object_type": "account",
"panels": [
"alerts"
],
"reactions": [
{
"emoji": "string",
"reacted": true,
"total_users": 0
}
],
"sync_metadata": {
"external_reference": "string",
"last_sync_in": {
"status": "failed",
"sync_date": "2023-01-01T12:00:00.000Z",
"sync_unit": {
"display_id": "string",
"id": "string",
"external_system_type": "adaas",
"is_archived": true,
"name": "string",
"sync_run": {
"mode": "initial",
"progress": {
"state": "completed"
}
},
"sync_type": "manual"
}
},
"last_sync_out": {
"status": "failed",
"sync_date": "2023-01-01T12:00:00.000Z",
"sync_unit": {
"display_id": "string",
"id": "string",
"external_system_type": "adaas",
"is_archived": true,
"name": "string",
"sync_run": {
"mode": "initial",
"progress": {
"state": "completed"
}
},
"sync_type": "manual"
}
},
"origin_system": "string"
},
"thread": {
"total_replies": 0
},
"visibility": "external",
"event": {
"type": "annotated",
"created": {
"object": {
"type": "account",
"display_id": "string",
"id": "string",
"display_name": "string"
}
},
"deleted": {
"object_id": "string"
},
"linked": {
"link": {
"display_id": "string",
"id": "string",
"link_type": "custom_link",
"source": {
"type": "account",
"display_id": "string",
"id": "string",
"display_name": "string"
},
"target": {
"type": "account",
"display_id": "string",
"id": "string",
"display_name": "string"
}
}
},
"updated": {
"field_deltas": [
{
"field_descriptor": {
"field_type": "array",
"description": "string",
"is_filterable": true,
"is_immutable": true,
"is_pii": true,
"is_required": true,
"mfz": {},
"name": "string",
"oasis": {},
"origin": "string",
"ui": {
"client_overrides": [
{
"client_name": "string",
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"is_required": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_overrides": [
{
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"is_required": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_name": "string"
}
]
}
],
"create_view": {
"is_hidden": true
},
"decimal_places": 0,
"detail_view": {
"is_hidden": true
},
"display_name": "string",
"filter_view": {
"is_hidden": true
},
"group_name": "string",
"is_active_in_detail_view": true,
"is_bulk_action_enabled": true,
"is_currency_field": true,
"is_groupable": true,
"is_hidden": true,
"is_hidden_during_create": true,
"is_read_only": true,
"is_required": true,
"is_shown_in_summary": true,
"is_sortable": true,
"list_view": {
"is_hidden": true
},
"order": 0,
"placeholder": "string",
"summary_view": {
"is_hidden": true
},
"tooltip": "string",
"unit": "string",
"use_shorthand_notation": true
},
"default_value": true
},
"name": "string",
"new_value": {
"type": "bool",
"value": true
},
"old_value": {
"type": "bool",
"value": true
}
}
],
"object_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"
}