Custom Message

Send app-defined custom chat message payloads.

Use custom messages when your app needs to send structured data that is not one of the built-in text or media message types. Keep the payload JSON-serializable and version your custom schema in your app code so older clients can render safely.

Parameters

Parameter	Required	Description
subChannelId	Yes	Target subchannel where the custom message will be created.
data	Yes	JSON-serializable custom payload owned by your app.
parentId	No	Parent message ID when sending the custom message as a reply.
tags	No	App-defined tags for filtering or grouping custom messages.
metadata	No	App-defined metadata stored with the message.

Send A Custom Message

Create a custom message with a JSON-serializable payload that your app knows how to render.

TypeScript

import { MessageRepository } from '@amityco/ts-sdk';

const { data: message } = await MessageRepository.createMessage({
  subChannelId,
  dataType: 'custom',
  data: {
    kind: 'location',
    latitude: 13.7563,
    longitude: 100.5018,
  },
});

renderResults(message);

Add Tags, Metadata, Or Reply Context

Attach app-owned tags, metadata, or a parentId when the custom message needs filtering, rendering context, or reply threading.

TypeScript

import { MessageRepository } from '@amityco/ts-sdk';

const { data: reply } = await MessageRepository.createMessage({
  subChannelId,
  parentId: messageId,
  dataType: 'custom',
  data: {
    kind: 'system-card',
    title: 'Order received',
  },
  tags: ['system'],
  metadata: {
    source: 'checkout',
  },
});

Rendering Guidance

• Treat data as an app-owned contract.
• Include a type or version field such as kind so clients can choose the renderer.
• Provide a fallback renderer for unknown custom payloads.
• Keep sensitive data out of custom payloads unless your product explicitly requires it.

Related Topics

Text Message

Send plain chat content.

Reply to a Message

Send custom replies with parentId.