Learn how to read, create, and delete timeline items from the Email & Activities app using the platform API

🚧

Only available in API version 2024-10

The Emails & Activities app (E&A) is a useful tool that enables monday.com CRM customers to manage client communication in one centralized location. Each contact is logged and tracked in the app's timeline for easy access to important details and updates.

Queries

Querying timeline_item will return metadata about newly created items in the E&A timeline. This method accepts one argument, returns an array, and can only be queried at the root.

Please note that currently you can only query timeline items created through the create_timeline_item mutation, so it isn't possible to query existing timeline items. The id argument is required to query a timeline item, and the only way to retrieve it is by querying it back after running the create_timeline_item mutation.

query {
  timeline_item (id: "6376175611") {
    board {
      id
    }
    item {
      name
    }
    id
    ref_id
    user {
      id
      name
    }
    title
    type
  }
}

Arguments

You can use the following argument(s) to reduce the number of results returned in your timeline_item query.

ArgumentDescription
id String!The unique identifier of the timeline item to return. Please note that currently, the only way to retrieve a timeline item's ID is by querying it back after running the create_timeline_item mutation.

Fields

You can use the following field(s) to specify what information your timeline_item query will return.

FieldDescription
board BoardThe board that the timeline item is on.
id ID!The timeline item's unique identifier.
item ItemThe item that the timeline item is on.
title StringThe title of the timeline item.
type String!The type of timeline item. Always returns "activity".
user UserThe user who created the timeline item.

Mutations

Create a timeline item

The create_timeline_item mutation allows you to create a new timeline item in the E&A app via the API. You can also specify what fields to query back from the new item when you run the mutation. Please note that currently, this is the only way you can retrieve a timeline item's ID. It is not possible to retrieve it from the UI.

mutation {
	create_timeline_item (
  item_id: 9876543210,
  title: "Migrated Email",
  summary: "internal company email",
  content: "From: [email protected] <br> To: [email protected] [Asi Monday], [email protected] [Yoni Monday] <br> Subject: Deploy our first alpha version <br><br>Hey guys, <br>We are ready to deploy our first alpha version and enable<br>our clients to migrate into E&A!<br><br>Best regards,<br> Saar",
	timestamp: "2024-06-06T18:00:30Z",
  time_range: {
   start_timestamp: "2024-05-06T18:00:30Z", 
   end_timestamp: "2024-05-06T19:00:30Z"
  }
 ) {
  id
 }
}

Arguments

You can use the following argument(s) to define the new timeline item's characteristics.

ArgumentDescriptionSupported fields
content StringThe new timeline item's content.
item_id ID!The ID of the item to create the new timeline item on.
location StringThe location to add to the new timeline item. Please note that this input isn't verified as a location.
phone StringThe phone number to add to the new timeline item. Please note that this input isn't verified as a phone number.
summary StringThe new timeline item's summary, 255 characters or less.
timestamp ISO8601DateTime!The new timeline item's creation time.
time_range TimelineItemTimeRangeThe start and end time of the new timeline item.end_timestamp ISO8601DateTime!
start_timestamp ISO8601DateTime!
title String!The new timeline item's title.
url StringThe URL to add to the new timeline item.

Delete a timeline item

The delete_timeline_item mutation allows you to delete a timeline item in the E&A app via the API. You can also specify what fields to query back from the deleted item when you run the mutation.

mutation {
  delete_timeline_item (id: 1234567890) {
    id
  }
}

Arguments

You can use the following argument to define which timeline item to delete.

ArgumentDescription
id ID!The unique identifier of the timeline item to delete.