Skip to main content

Communication

Record of a communication sent to a recipient.

type Communication {
  contactMethod: ContactMethod!
  createdBy: User!
  details: String
  error: String @deprecated
  eventAt: DateTime
  id: ID!
  purpose: CommunicationPurpose!
  recipient: Identity!
  sentAt: DateTime!
  status: CommunicationStatus!
}

Fields​

Communication.contactMethod ● ContactMethod! non-null enum​

The contact method used to send the communication.

Communication.createdBy ● User! non-null object​

The user (Person or Application) whose action resulted in the communication.

Communication.details ● String scalar​

Additional details about the communication entry.

Communication.error ● String deprecated scalar​

DEPRECATED

Use level and details fields instead

The error while sending the communication, if any.

Communication.eventAt ● DateTime scalar​

The time the email event actually occurred at SendGrid's infrastructure, taken from the webhook payload timestamp. Null for sent rows and legacy rows recorded before this field was added. Prefer this over sentAt for chronological ordering when non-null.

Communication.id ● ID! non-null scalar​

Communication.purpose ● CommunicationPurpose! non-null enum​

The purpose of the communication.

Communication.recipient ● Identity! non-null object​

The recipient of the communication.

Communication.sentAt ● DateTime! non-null scalar​

When the communication was sent.

Communication.status ● CommunicationStatus! non-null enum​

The status this communication entry represents.

Returned By​

findCommunications query

Member Of​

AsyncIssuanceRequest object ● PresentationFlow object