Recipients

recipients

Domain types

ChannelData = { __typename, channel_id, data }

Channel data for various channel types

ChannelDataRequest = { data }

Set channel data for a type of channel

DiscordChannelData = { connections }

Discord channel data

InlineChannelDataRequest = Record<string, >

Allows inline setting channel data for a recipient

InlinePreferenceSetRequest = Record<string, >

Inline set preferences for a recipient, where the key is the preference set name

MsTeamsChannelData = { connections, ms_teams_tenant_id }

Microsoft Teams channel data

OneSignalChannelData = { player_ids }

OneSignal channel data

PreferenceSet = { id, __typename, categories, 2 more... }

A preference set object.

PreferenceSetChannelTypeSetting = { conditions }

A set of settings for a channel type. Currently, this can only be a list of conditions to apply.

PreferenceSetChannelTypes = { chat, email, http, 3 more... }

Channel type preferences

PreferenceSetRequest = { categories, channel_types, workflows }

Set preferences for a recipient

PushChannelData = { tokens }

Channel data for push providers

Recipient = |

A recipient, which is either a user or an object

RecipientRequest = string | |

Specifies a recipient in a request. This can either be a user identifier (string), an inline user request (object), or an inline object request, which is determined by the presence of a collection property.

SlackChannelData = { connections, token }

Slack channel data

Subscription = { __typename, inserted_at, object, 3 more... }

A subscription object