Skip to content

Notifications Overview

ApiMeld scripts can send notifications to Slack, Microsoft Teams, Mattermost, or email at any point during execution. Webhooks are configured once by an admin and referenced by name from any script.

Supported channels

ChannelSetup required
SlackIncoming webhook URL from Slack
Microsoft TeamsIncoming webhook URL from Teams
MattermostIncoming webhook URL from Mattermost
EmailSMTP configuration in Admin → Settings

How it works

  1. Admin configures one or more named webhooks (e.g. "Ops Team Slack", "Dev Alerts Teams") in Admin → Settings → Notifications
  2. Scripts call the injected $notifications object at any point during execution, referencing the webhook by name

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
  • Restrict each notification type (Slack, Teams, Mattermost, Email) to admins only, or allow all users
  • Enable or disable email notifications globally

Sending from a script

Every script has a $notifications object injected at runtime. Call it anywhere in your script to send a message to a named webhook — useful for progress updates, summaries, or error alerts mid-execution.

For language-specific syntax and examples, see each channel's guide:

Access control

Each notification type can be restricted to admins only or left open to all users. This is configured per type (Slack, Teams, Mattermost, Email) in Admin → Settings → Notifications.