Skip to main content

NotificationSubscription

A notification subscription that links a recipient to a target entity.

type NotificationSubscription {
active: Boolean
application: App
createdAt: Date
description: String
entityType: String!
entityValue: String!
id: Int!
meta: NotificationSubscriptionMeta
notificationRecipient: NotificationRecipient
updatedAt: Date
vin: Boolean
}

Fields​

NotificationSubscription.active ● Boolean scalar common​

Whether the subscription is active.

NotificationSubscription.application ● App object common​

The application associated with the subscription target, when available.

NotificationSubscription.createdAt ● Date scalar common​

When the subscription was created.

NotificationSubscription.description ● String scalar common​

Notes describing the subscription.

NotificationSubscription.entityType ● String! non-null scalar common​

The entity type the subscription applies to.

NotificationSubscription.entityValue ● String! non-null scalar common​

The entity identifier or pattern the subscription applies to.

NotificationSubscription.id ● Int! non-null scalar common​

The unique identifier for the subscription.

NotificationSubscription.meta ● NotificationSubscriptionMeta object common​

Additional metadata for the subscription.

NotificationSubscription.notificationRecipient ● NotificationRecipient interface common​

The recipient that receives notifications for this subscription.

NotificationSubscription.updatedAt ● Date scalar common​

When the subscription was last updated.

NotificationSubscription.vin ● Boolean scalar common​

Whether the subscription is for Very Important Notifications.

Member Of​

AddNotificationSubscriptionPayload object ● App object ● NotificationSubscriptionList object ● Organization object ● UpdateNotificationSubscriptionPayload object