Notifications Overview

ApiMeld can send notifications when tasks complete, fail, or time out. Notifications are configured once at the admin level and then referenced by name in individual tasks.

Supported channels

Channel	Setup required
Slack	Incoming webhook URL from Slack
Microsoft Teams	Incoming webhook URL from Teams
Mattermost	Incoming webhook URL from Mattermost
Email	SMTP configuration in Admin → Settings

How it works

1. Admin configures one or more named webhooks (e.g. "Ops Team Slack", "Dev Alerts Teams")
2. Task owner selects which webhook(s) to notify and on which events (success, failure, timeout)
3. When a task run completes, ApiMeld sends the notification automatically including the run status, duration, and a summary of the output

Admin configuration

Go to Admin → Settings → Notifications to:

• Add and name Slack incoming webhook URLs
• Add and name Teams incoming webhook URLs
• Add and name Mattermost incoming webhook URLs
• Configure which user roles are allowed to use each notification channel
• Enable or disable email notifications globally

Sending from a script

In addition to automatic post-run notifications, scripts can send notifications mid-execution using the notification API. This is useful for sending partial results or progress updates for long-running tasks.

PowerShell:

# Send a mid-run notification (does not affect the final run notification)
Invoke-RestMethod `
    -Uri "https://tasks.example.com/api/notifications/send" `
    -Method POST `
    -Headers $AuthHeaders `
    -ContentType "application/json" `
    -Body (@{
        channel = "ops-slack"
        message = "Sync in progress: 500/1000 records processed"
    } | ConvertTo-Json)

Role-based access

Admins can restrict which user roles are allowed to use each notification channel. For example, you might allow all users to send to a general channel but restrict a high-priority alerting channel to admins only.