Weave Code
Microsoft Teams Notifier Laravel Package
symfony/microsoft-teams-notifier
Symfony Notifier bridge for Microsoft Teams Incoming Webhooks. Configure via MICROSOFT_TEAMS_DSN and send ChatMessage notifications, with support for MessageCard options like sections, facts, and interactive actions/inputs.
Symfony Microsoft Teams Notifier Bridge
Frequently asked questions about Microsoft Teams Notifier
- Can I use this package directly in Laravel without Symfony dependencies?
- No, this package requires Symfony Notifier (v6.4+/v7.4+). For Laravel, you’d need to either: 1) Use Laravel’s Symfony Bridge, 2) Create a wrapper service to abstract Symfony dependencies, or 3) build a custom facade. Pure Laravel integration isn’t officially supported.
- How do I set up the Microsoft Teams webhook in Laravel?
- First, create an Incoming Webhook in Microsoft Teams. Then, store the webhook URL in Laravel’s `.env` as `MICROSOFT_TEAMS_DSN=microsoftteams://default/PATH`, where `PATH` follows the format `webhookb2/{uuid}@{uuid}/IncomingWebhook/{id}/{uuid}`. Ensure the URL is securely stored.
- What Laravel versions support this package?
- This package requires PHP 8.1+, which aligns with Laravel 10.x. For Laravel 9.x (PHP 8.0), you’d need to pin Symfony Notifier to a compatible version (e.g., v6.4.x) or upgrade Laravel. Check Symfony’s requirements for exact compatibility.
- How do I send a simple text message to Teams?
- Use the `ChatMessage` class with the `MicrosoftTeamsTransport`. Example: `$chatMessage = (new ChatMessage('Hello Teams'))->transport('microsoftteams');` then send it via `$chatter->send($chatMessage)`. Ensure your DSN is configured in `.env` first.
- Can I add buttons or interactive elements to notifications?
- Yes, use `MicrosoftTeamsOptions` to add interactive elements like buttons, text inputs, or date pickers. For example, create an `ActionCard` with `HttpPostAction` for clickable buttons or `TextInput` for user responses. This requires building a `MessageCard` with sections and facts.
- Will this work with Laravel’s queue system for async notifications?
- Not natively. Symfony Notifier uses Messenger for async sending, while Laravel uses queues. You’d need to bridge the two—either by creating a custom queue transport or using Symfony Messenger alongside Laravel’s queue system. This adds complexity but is feasible.
- Are there alternatives for sending Teams notifications in Laravel?
- Yes. For basic text messages, Laravel’s native `Notification` system with a custom `TeamsChannel` works. For rich `MessageCards`, consider: 1) Using the `guzzlehttp/guzzle` package to manually call Teams’ API, or 2) forking this package to remove Symfony dependencies and adapt it for Laravel.
- How do I handle errors or failed webhook deliveries?
- Symfony Notifier supports retries and backoff for failed deliveries. Configure this in your transport settings. For Laravel, you’d need to log failures (e.g., via Laravel’s logging) and implement retry logic, possibly using Laravel’s queue failed job system or a custom event listener.
- Can I use this for production alerts (e.g., CI/CD failures)?
- Yes, but ensure your DSN is securely stored (e.g., Laravel’s `.env` or a secrets manager). For high-frequency alerts, consider async sending with retries. Test rate limits—Microsoft Teams may throttle requests. Use `MessageCard` sections to prioritize critical alerts.
- How do I customize the appearance of Teams notifications (e.g., colors, layout)?
- Use `MicrosoftTeamsOptions` to customize themes, titles, summaries, and sections. Set a `themeColor` (e.g., `#F4D35E`), add `Fact` objects for key-value pairs, and structure content with `Section` objects. For advanced layouts, use adaptive cards via the `ActionCard` class.
Weaver
How can I help you explore Laravel packages today?