CommentEvent object

Comment events are generated by staff members of a shop. They are created when a staff member adds a comment to the timeline of an order, draft order, customer, or transfer.

On this page

Fields

  • appTitle ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The name of the app that created the event. Returns null when the event originates from the Shopify admin.
  • attachments ([[CommentEventAttachment!]!](https://shopify.dev/docs/admin-api/graphql/reference/events/commenteventattachment))
    The attachments associated with the comment event.
  • attributeToApp ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the event was created by an app.
  • attributeToUser ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the event was caused by an admin user.
  • canDelete ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the comment event can be deleted. If true, then the comment event can be deleted.
  • canEdit ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the comment event can be edited. If true, then the comment event can be edited.
  • createdAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the event was created.
  • criticalAlert ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the event is critical.
  • edited ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the comment event has been edited. If true, then the comment event has been edited.
  • embed ([CommentEventEmbed](https://shopify.dev/docs/admin-api/graphql/reference/events/commenteventembed))
    The references associated with the comment event.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • message ([FormattedString!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#formattedstring-2021-01))
    Human readable text that describes the event.
  • rawMessage ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The raw body of the comment event.
  • subject ([CommentEventSubject!](https://shopify.dev/docs/admin-api/graphql/reference/events/commenteventsubject))
    The subject of the comment event.

Implements

  • [Event](https://shopify.dev/docs/admin-api/graphql/reference/events/event)
  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)