Skip to main content

companyInAppNotificationUpdates

Subscribe to real-time in-app notification updates for a party, scoped to the company the person is currently working in.

Authentication​

Authentication is required. Unauthenticated requests will fail.

Authorization​

The person must be authorized on companyId, and partyId must be either the current user or that same company. This keeps the live connection limited to a single company: notifications from another company, or from another person in the same company, never reach it.

Events​

Subscribers receive updates when a notification is created, marked as read or unread, or dismissed.

companyInAppNotificationUpdates(
companyId: ID!
partyId: ID!
): InAppNotificationPayload!

Arguments​

companyInAppNotificationUpdates.companyId ● ID! non-null scalar common​

The company the person is working in. Updates are limited to this company.

companyInAppNotificationUpdates.partyId ● ID! non-null scalar common​

The party ID to receive notification updates for. Either the current user or the company they belong to.

Type​

InAppNotificationPayload object common​