Communication GraphQL API Documentation

The Communication module manages messaging templates and custom messages used throughout the Idukki platform. This includes default platform messages and business-specific overrides.

Data Types

CommunicationMessage

Represents a single communication message or template.

Field	Type	Description
`id`	`ID!`	Unique identifier for the message.
`messageType`	`String!`	The category or type of the message (e.g., "SMS", "EMAIL").
`defaultMessageContent`	`String`	The system's default content for this message type.
`overriddenMessageContent`	`String`	Custom content provided by the business to override the default.
`platformDefaultMessage`	`Boolean!`	Flag indicating if this is a platform-wide default template.
`messageName`	`String`	A descriptive name for the message.
`bid`	`String`	Business ID the message belongs to (if not a platform default).
`createdAt`	`String!`	Timestamp when the message was created.
`updatedAt`	`String!`	Timestamp when the message was last updated.

Queries

`communicationMessages`

Fetches all communication messages associated with the current business context.

Returns: [CommunicationMessage!]!

`communicationMessage(id: ID!)`

Fetches a specific message by its ID. It must belong to the current business context.

Arguments:

id: The ID of the message.

Returns: CommunicationMessage

`messageByType(bid: String!, messageType: String!)`

Fetches a message for a specific business by its type. If no custom message is found for the business, it returns the platform default for that type.

Arguments:

bid: The Business ID.

messageType: The type of message to retrieve.

Returns: CommunicationMessage

Mutations

`createCommunicationMessage(input: CreateCommunicationMessageInput!)`

Creates a new custom message for the business.

Input: CreateCommunicationMessageInput

messageType: String (Required)

message: String (Required) - Maps to overriddenMessageContent.

messageName: String (Required)

Returns: CommunicationMessage!

`updateCommunicationMessage(input: UpdateCommunicationMessageInput!)`

Updates an existing custom message.

Input: UpdateCommunicationMessageInput

id: ID (Required)

messageType: String (Required)

message: String (Required)

messageName: String (Required)

Returns: CommunicationMessage!

`deleteCommunicationMessage(id: ID!)`

Deletes a custom message for the business.

Arguments:

id: ID of the message to delete.

Returns: CommunicationMessage!

Communication

Communication GraphQL API Documentation

Data Types

CommunicationMessage

Queries

`communicationMessages`

`communicationMessage(id: ID!)`

`messageByType(bid: String!, messageType: String!)`

Mutations

`createCommunicationMessage(input: CreateCommunicationMessageInput!)`

`updateCommunicationMessage(input: UpdateCommunicationMessageInput!)`

`deleteCommunicationMessage(id: ID!)`

Usage Examples

Fetching All Business Messages

Creating a New Message

Fetching Message by Type (with Default Fallback)

Communication

Communication GraphQL API Documentation#

Data Types#

CommunicationMessage#

Queries#

communicationMessages#

communicationMessage(id: ID!)#

messageByType(bid: String!, messageType: String!)#

Mutations#

createCommunicationMessage(input: CreateCommunicationMessageInput!)#

updateCommunicationMessage(input: UpdateCommunicationMessageInput!)#

deleteCommunicationMessage(id: ID!)#

Usage Examples#

Fetching All Business Messages#

Creating a New Message#

Fetching Message by Type (with Default Fallback)#

Communication GraphQL API Documentation

Data Types

CommunicationMessage

Queries

`communicationMessages`

`communicationMessage(id: ID!)`

`messageByType(bid: String!, messageType: String!)`

Mutations

`createCommunicationMessage(input: CreateCommunicationMessageInput!)`

`updateCommunicationMessage(input: UpdateCommunicationMessageInput!)`

`deleteCommunicationMessage(id: ID!)`

Usage Examples

Fetching All Business Messages

Creating a New Message

Fetching Message by Type (with Default Fallback)