{"id":48987507,"url":"https://github.com/dix/mattermost.sh","last_synced_at":"2026-04-18T13:11:17.087Z","repository":{"id":321922163,"uuid":"1087634565","full_name":"dix/mattermost.sh","owner":"dix","description":"Bash script sending Mattermost notifications using incoming webhooks ","archived":false,"fork":false,"pushed_at":"2025-11-01T11:35:06.000Z","size":746,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-01T12:19:16.449Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-01T10:19:31.000Z","updated_at":"2025-11-01T11:35:10.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/dix/mattermost.sh","commit_stats":null,"previous_names":["dix/mattermost.sh"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/dix/mattermost.sh","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dix%2Fmattermost.sh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dix%2Fmattermost.sh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dix%2Fmattermost.sh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dix%2Fmattermost.sh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dix","download_url":"https://codeload.github.com/dix/mattermost.sh/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dix%2Fmattermost.sh/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31970009,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-18T13:11:09.669Z","updated_at":"2026-04-18T13:11:17.078Z","avatar_url":"https://github.com/dix.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mattermost.sh\n\n* [Presentation](#presentation \"Presentation\")\n* [Dependencies](#dependencies \"Dependencies\")\n* [Usage](#usage \"Usage\")\n* [Options](#options \"Options\")\n* [Docker](#docker \"Docker\")\n* [Limitations](#limitations \"Limitations\")\n* [Acknowledgements](#acknowledgements \"Acknowledgements\")\n\n## Presentation\n\nA pure bash script sending Mattermost notifications through incoming webhooks.\n\n[![Notification example](./static/notification_example.png#center \"Notification example\")](./static/notification_example.png)\n\n## Dependencies\n\n* [jq](https://jqlang.org/ \"JQLang\")\n\n## Usage\n\n1. [Get a webhook URL](https://developers.mattermost.com/integrate/webhooks/incoming/ \"Mattermost\")\n2. Download `mattermost.sh` and make sure it has the `execute` authorization (`chmod +x mattermost.sh`)\n3. Call `mattermost.sh --webhook-url $WEBHOOK_URL` to test it\n4. Fully configure your notifications using the whole set of options described below\n\n## Options\n\n[![Notification content](./static/notification_content.png#center \"Notification content\")](./static/notification_content.png)\n\n1. `--title`\n2. `--username`\n3. `--avatar`\n4. `--description`\n5. `--color`\n6. `--field`\n7. `--link`\n8. `--channel`\n\n⚠️ **None of those parameters are required** ⚠️\n\n### `--title STRING`\n\nSet a title to the notification\n\n### `--username STRING`\n\nSet an author to the notification\n\n### `--avatar URL`\n\nSet a custom avatar for the notification author\n\n### `--description STRING`\n\nAdd a text description to the notification\n\n### `--color (#hex-color)`\n\nSet the color of the notification.\n\n### `--field STRING;STRING`\n\nAdd a field `NAME Value` to the notification.\n\nThis option can be provided O to n times to add n fields.\n\n### `--link STRING;URL`\n\nAdd a link to the notification.\n\nThis option can be provided O to n times to add n links.\n\n### `--channel STRING`\n\nOverwrite the default channel to send the notification to.\n\nThe expected value is the channel `slug` as defined in its URL, not its display name.\n\nThe incoming webhook must not be locked to its default channel.\n\n## Docker\n\nA Docker image is available: `ghcr.io/dix/mattermost.sh`.\n\nIt can be used directly within a CI job to send notifications using a lightweight image.\n\nList of tags: [https://github.com/dix/mattermost.sh/pkgs/container/mattermost.sh](https://github.com/dix/mattermost.sh/pkgs/container/mattermost.sh \"GitHub\").\n\n## Limitations\n\nIn its current iteration, the script relies on some hard-coded settings that can't be modified through parameters and require important changes to the source code, mainly:\n- timezones for the notifications\n\n## Acknowledgements\n\nHeavily inspired by [fieu/discord.sh](https://github.com/fieu/discord.sh \"GitHub\").","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdix%2Fmattermost.sh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdix%2Fmattermost.sh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdix%2Fmattermost.sh/lists"}