Skip to main content

When this fires

Triggered when a new direct message is received in a creator’s inbox.

Payload

  • message: Details of the message (uuid, text, hasMedia, mediaUuids, price, createdAt). mediaUuids is the ordered list of media UUIDs attached to the message (display order); price is in cents for pay-to-view messages.
  • messageUuid: Unique identifier for the message
  • sender: The user who sent the message (uuid, handle, displayName, avatarUrl)
  • recipientUuid: UUID of the creator who received the message
  • isMuted: Whether the recipient has muted the sender
  • timestamp: ISO 8601 time the event occurred

Example payload

{
  "message": {
    "uuid": "2f7c5e8a-6d36-4e3a-98d9-9f1b3b0a1a10",
    "text": "Hey! Is this still available?",
    "hasMedia": true,
    "mediaUuids": [
      "b8c47a91-3f2d-4a55-b7e8-1c9d2e4f5a6b"
    ],
    "price": 300,
    "createdAt": "2026-05-20T08:39:33.139Z"
  },
  "messageUuid": "2f7c5e8a-6d36-4e3a-98d9-9f1b3b0a1a10",
  "sender": {
    "uuid": "5939ae62-3eb5-4433-954f-f78c7b4282f3",
    "handle": "test-user",
    "displayName": "Test User",
    "avatarUrl": "https://via.placeholder.com/150"
  },
  "recipientUuid": "f4b2a184-2b4a-4a04-9b70-3c0e0a1caa12",
  "isMuted": false,
  "timestamp": "2026-05-20T08:39:33.310Z"
}