BroadcastCommunication

Represents a broadcast communication related to an incident.

Introduced in API version 56.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete()

  • To access this object with Service Cloud, enable Incident Management in setup and set up Broadcast Communications.

  • Type: textarea

  • Properties: Create, Nillable

  • Description:

    • If BroadcastType is Alert, this field contains the alert message.
    • If BroadcastType is Email, this field contains the email body text.
    • If BroadcastType is ExperienceSiteBanner, this field is empty.
    • If BroadcastType is Slack, this field contains the Slack message.
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: Auto-generated number for every BroadcastCommunication record.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort
  • Description: Medium used to distribute the message.
  • Possible values:
    • Alert — Alert
    • Email — Email
    • ExperienceSiteBanner — ExperienceSiteBanner
    • Slack — Slack

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort

  • Introduced: API version 58.0

  • Description:

    ID of the custom notification template used to frame the Slack message. Only applies if BroadcastType is Slack.

    This field is a relationship field.

  • Relationship name: CustomNotificationType

  • Relationship type: relationship

  • Refers to: CustomNotificationType

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort

  • Introduced: API version 68.0

  • Default value: false

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    ID of the incident associated with the broadcast communication.

    This field is a relationship field.

  • Relationship name: RelatedRecord

  • Relationship type: polymorphic

  • Refers to: ChangeRequest, Incident

  • Type: textarea

  • Properties: Create, Nillable

  • Description:

    • If BroadcastType is Alert, this field is the alert message in the format “Incident Alert | | .”
    • If BroadcastType is Email, this field is the subject of the email sent.
    • If BroadcastType is ExperienceSiteBanner, this field is empty.
    • If BroadcastType is Slack, this field is in the format “Incident Alert | .”

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.