Skip to main content

Discord Settings

API settings for posting to Discord

Settings Schema​

When posting a message to Discord, use the following settings schema:

{
  "settings": {
    "__type": "discord",
    "channel": "channel-id"
  }
}

Fields​

FieldTypeRequiredDescription
__typestringYesMust be discord
channelstringYesDiscord channel ID

channel​

The Discord channel ID where the message will be posted. This is required.

note

How to get a Discord channel ID:

  1. Enable Developer Mode in Discord (User Settings → App Settings → Advanced → Developer Mode)
  2. Right-click on the channel
  3. Click "Copy Channel ID"

Complete Example​

Text Message​

{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-discord-integration-id"
      },
      "value": [
        {
          "content": "🎉 **New Update Released!**\n\nWe've just shipped some exciting new features:\n\n• Feature 1\n• Feature 2\n• Feature 3\n\nCheck it out and let us know what you think!",
          "image": []
        }
      ],
      "settings": {
        "__type": "discord",
        "channel": "1234567890123456789"
      }
    }
  ]
}

Message with Image​

{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-discord-integration-id"
      },
      "value": [
        {
          "content": "Check out this preview of our new feature! 👀",
          "image": [
            {
              "id": "preview-image-id",
              "path": "https://uploads.sipstory.com/preview.png"
            }
          ]
        }
      ],
      "settings": {
        "__type": "discord",
        "channel": "1234567890123456789"
      }
    }
  ]
}

Announcement with Formatting​

{
  "type": "now",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-discord-integration-id"
      },
      "value": [
        {
          "content": "# 📢 Important Announcement\n\n> We'll be performing scheduled maintenance tonight from 10 PM - 12 AM UTC.\n\n**What to expect:**\n- Brief service interruption\n- Improved performance after maintenance\n\n*Thank you for your patience!*",
          "image": []
        }
      ],
      "settings": {
        "__type": "discord",
        "channel": "9876543210987654321"
      }
    }
  ]
}
info

Discord supports Markdown formatting in messages. You can use:

  • **bold** for bold
  • *italic* for italic
  • # Heading for headings
  • > quote for quotes
  • `code` for inline code