Broadcast Object

Root Connection

All Broadcast objects of an account are accessible by a query on the root connection broadcasts. Such a query will return a BroadcastConnection!, which contains the Broadcast objects in its nodes field.

broadcasts (BroadcastConnection!)

Root connection for retrieving Broadcast records.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

filter BroadcastFilter

Filter to determine which Broadcast records are returned.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

Fields

The fields in this section list which values can be retrieved when querying Broadcast records.

account (Account)

The account this record belongs to.

createdAt (ISO8601Timestamp)

The date and time at which the record was created.

disabled (Boolean)

Whether the message should not be broadcasted.

endAt (ISO8601Timestamp)

Used to select the end date and time of the broadcast. This field is left empty when the message is to be broadcasted until the Disabled box is checked. (If the broadcast should end at midnight at the end of a day, specify 12:00am or 24:00.)

id (ID!)

Unique identifier of the object.

messageType (BroadcastMessageType)

Used to select the appropriate icon for the message. The selected icon is displayed alongside the message when the broadcast is presented.

source (String)

An identifier for the client application submitting the resource or the name of an external system

sourceID (String)

The unique identifier of the resource in an external system

startAt (ISO8601Timestamp)

Used to specify the start date and time of the broadcast. (If the broadcast should start at midnight at the start of a day, specify 00:00.)

timeZone (TimeZone)

Used to select the time zone that applies to the dates and times specified in the Start and End fields.

updatedAt (ISO8601Timestamp)

The date and time of the last update of the record. If the record has no updates it contains the createdAt value.

visibility (BroadcastVisibility)

Used to define the target audience of the broadcast.

Connections

The connection fields in this section allow (paged) access to objects related to a specific Broadcast record. The actual objects will be in the nodes field of the connection.

customers (OrganizationConnection)

Used to select one or more customer organizations when the broadcast is to be displayed for the specialists of the account in requests that were received from the selected organizations. This field is available only when the "Specialists in requests from the following customers" visibility option is selected.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

serviceInstances (ServiceInstanceConnection)

Used to select the service instances for which the people, who are covered for them by an active SLA, need to see the broadcast. This table field is available only when the "People covered for the following service instance(s)" visibility option is selected.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

teams (TeamConnection)

Used to select the teams which members need to see the broadcast. This table field is available only when the "Members of the following team(s)" visibility option is selected.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

before String

Returns the elements in the list that come before the specified cursor.

first Int

Returns the first n elements from the list.

last Int

Returns the last n elements from the list.

Implements

Broadcast implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a Broadcast.