Connections

Connect a Discord channel

Adds a Discord channel to the workspace by its webhook URL. In Discord, open Server Settings → Integrations → Webhooks, pick the channel, and use Copy Webhook URL.

Works for every channel type, including forum channels, which the dashboard's "Add a channel with Discord" screen can't list. In a forum channel each post becomes a new forum post titled with platform_options.discord.thread_name (or the caption's first line), and first_comment is its first reply. In text channels first_comment is a separate message right after the post.

The URL is checked against Discord and stored encrypted; it is never returned. A workspace has one Discord connection that can hold several channels: each call with a new webhook adds a channel and returns the same connection id; posting a webhook that's already connected refreshes that channel. The first channel becomes a default channel; later ones are added with is_default: false (change it with PATCH /api/v1/discord/channels/{channel_id}).

post/auth/discord/webhook

Request

  • Base URL: https://api.shortsync.app/v1
  • URL: https://api.shortsync.app/v1/auth/discord/webhook
  • Auth: HTTP bearer

Request body

webhook_urlstring uri required
labelstring

Display name for the channel. Defaults to the webhook's name.

Example request

{
  "webhook_url": "https://discord.com/api/webhooks/123456789012345678/abcDEF..."
}

Response

The workspace's Discord connection, plus the channel that was added in channel.

idstring required
workspace_idstring required
platform'instagram' | 'tiktok' | 'youtube' | 'facebook' | 'snapchat' | 'pinterest' | 'threads' | 'twitter' | 'bluesky' | 'linkedin' | 'reddit' | 'telegram' | 'mastodon' | 'discord' | 'tumblr' | 'pixelfed' | 'google_business' required
display_namestring nullable

Username or page name from the upstream platform.

status'active' | 'token_expired' | 'refresh_failed' | 'needs_reconnect' | 'rate_limited' required
scopesstring[]

OAuth scopes granted by the user.

connected_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.