Skip to main content

​
Settings Schema

When creating a post for Twitch, use the following settings schema: 
{
  "settings": {
    "__type": "twitch",
    "messageType": "message",
    "announcementColor": "primary"
  }
}

​
Fields

FieldTypeRequiredDescription
__typestringYesMust be twitch
messageTypestringNoType of message to send
announcementColorstringNoColor for announcement messages

​
messageType

The type of message to send in Twitch chat.
ValueDescription
messageRegular chat message (default)
announcementAnnouncement message (highlighted in chat)

​
announcementColor

The color of the announcement banner. Only applies when messageType is announcement.
ValueDescription
primaryDefault purple color
blueBlue announcement
greenGreen announcement
orangeOrange announcement
purplePurple announcement

​
Complete Example

​
Regular Chat Message

{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-twitch-integration-id"
      },
      "value": [
        {
          "content": "Going live in 5 minutes! Today's stream: Ranked grind to Diamond 🎮",
          "image": []
        }
      ],
      "settings": {
        "__type": "twitch",
        "messageType": "message"
      }
    }
  ]
}

​
Announcement

{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-twitch-integration-id"
      },
      "value": [
        {
          "content": "🎉 HUGE NEWS! We just hit 10,000 followers! Thank you all so much for the support! Special stream tomorrow to celebrate!",
          "image": []
        }
      ],
      "settings": {
        "__type": "twitch",
        "messageType": "announcement",
        "announcementColor": "purple"
      }
    }
  ]
}

​
Green Announcement

{
  "type": "now",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-twitch-integration-id"
      },
      "value": [
        {
          "content": "✅ Giveaway winner announced! Congratulations to the lucky viewer! Check your DMs for prize details.",
          "image": []
        }
      ],
      "settings": {
        "__type": "twitch",
        "messageType": "announcement",
        "announcementColor": "green"
      }
    }
  ]
}
  • Regular messages appear as standard chat messages from your bot/account.
  • Announcements are highlighted with a colored banner and are more visible to viewers.
  • The announcementColor field is ignored when messageType is message.