Skip to main content

Custom Hooks (Channel Plugins)

Forum owners can configure plugins to automate workflows within their channels.

Overview

Channel-level plugins allow you to:

  • Automate responses to events
  • Integrate with external services
  • Add custom functionality to your channel

Channel Plugin Configuration

Accessing Plugin Settings

  1. Go to Channel Settings
  2. Navigate to Plugins tab
  3. View available plugins

Enabling Plugins

  1. Find the plugin you want to enable
  2. Toggle the switch to enable
  3. Configure any required secrets (if applicable)
  4. Save changes

Channel vs Server Plugins

ScopeConfigured ByRuns In
ServerServer AdminAll channels
ChannelForum OwnerYour channel only

Channel plugins run in addition to any server-level plugins.

Pipeline Configuration

Pipelines define when plugins run:

Available Events

EventWhen It Fires
discussionChannel.createdNew discussion in your channel
comment.createdNew comment in your channel
event.createdNew event in your channel

Setting Up Pipelines

  1. Go to Channel SettingsPipelines
  2. Select an event
  3. Add plugins to the pipeline
  4. Order plugins (they run sequentially)
  5. Save

Example configuration:

{
"discussionChannel.created": ["welcome-bot", "auto-tagger"],
"comment.created": ["link-previewer"]
}

Channel-Specific Secrets

Some plugins need channel-specific configuration:

Setting Secrets

  1. Go to Channel SettingsPlugins
  2. Find the plugin
  3. Click Configure Secrets
  4. Enter your values
  5. Save

Secret Types

ScopeDescription
serverSame value everywhere (set by admin)
channelCan be different for your channel

Only channel-scoped secrets can be set by forum owners.

Use Cases

Welcome Messages

Automatically welcome new posters:

Event: discussionChannel.created
Action: Post a welcome comment

Auto-Tagging

Automatically suggest or apply tags:

Event: discussionChannel.created
Action: Analyze content and suggest tags

External Notifications

Notify external services of new content:

Event: discussionChannel.created
Action: Send webhook to Discord/Slack

Content Moderation

Flag potentially problematic content:

Event: comment.created
Action: Analyze and create issue if needed

Viewing Plugin Activity

Execution Logs

  1. Go to Channel SettingsPlugins
  2. Click on a plugin
  3. View Recent Runs

Each run shows:

  • What triggered it
  • When it ran
  • Whether it succeeded
  • Any output or errors

Troubleshooting

If plugins aren't working:

  1. Check the plugin is enabled
  2. Verify pipeline configuration
  3. Check secrets are set
  4. Review execution logs for errors

Plugin Limitations

  • Plugins can't modify channel settings
  • Plugins run asynchronously (don't block posts)
  • Failed plugins don't prevent content creation
  • Rate limits may apply

Requesting New Plugins

If you need functionality that doesn't exist:

  1. Check with your server admin about available plugins
  2. Request a new plugin through appropriate channels
  3. Consider contributing a plugin yourself

Best Practices

Performance

  • Don't add too many plugins to pipelines
  • Consider necessity vs. overhead
  • Monitor execution times

Testing

  • Test plugins with non-critical content first
  • Review logs after enabling
  • Adjust configuration as needed

Security

  • Only use trusted plugins
  • Be careful with webhook URLs
  • Review what data plugins access