{"id":14371012,"url":"https://github.com/grafana/xk6-notification","last_synced_at":"2025-10-19T10:31:15.057Z","repository":{"id":47528840,"uuid":"314078421","full_name":"grafana/xk6-notification","owner":"grafana","description":"A k6 extension for creating notifications. ","archived":false,"fork":false,"pushed_at":"2024-06-10T08:30:02.000Z","size":23524,"stargazers_count":20,"open_issues_count":2,"forks_count":4,"subscribers_count":119,"default_branch":"main","last_synced_at":"2025-02-04T10:09:57.493Z","etag":null,"topics":["k6","k6-extension","shoutrrr","xk6"],"latest_commit_sha":null,"homepage":"","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grafana.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}},"created_at":"2020-11-18T22:55:49.000Z","updated_at":"2024-11-22T20:36:22.000Z","dependencies_parsed_at":"2023-08-07T20:28:22.114Z","dependency_job_id":"35363499-aab1-4ed7-8aea-363296330895","html_url":"https://github.com/grafana/xk6-notification","commit_stats":null,"previous_names":["dgzlopes/k6-extension-notification","grafana/xk6-notification","dgzlopes/xk6-notification"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grafana%2Fxk6-notification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grafana%2Fxk6-notification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grafana%2Fxk6-notification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grafana%2Fxk6-notification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grafana","download_url":"https://codeload.github.com/grafana/xk6-notification/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237109904,"owners_count":19257229,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["k6","k6-extension","shoutrrr","xk6"],"created_at":"2024-08-27T23:00:52.336Z","updated_at":"2025-10-19T10:31:09.724Z","avatar_url":"https://github.com/grafana.png","language":"Makefile","funding_links":[],"categories":["Extensions"],"sub_categories":["Official"],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"assets/logo.png\" width=400 height=400 alt=\"shoutrrr gopher with a k6 cap\" /\u003e\n\n## xk6-notification\n\nThis is a [k6](https://go.k6.io/k6) extension using the [xk6](https://github.com/grafana/xk6) system.\n\n\u003c/div\u003e\n\n\u003cbr/\u003e\n\n\u003e #### :exclamation: This is a proof of concept\n\u003e\n\u003e As such, it isn't supported by the k6 team, and may break in the future. USE AT YOUR OWN RISK!\n\n## Build\n\nTo build a `k6` binary with this extension, first ensure you have the prerequisites:\n\n- [Go toolchain](https://go101.org/article/go-toolchain.html)\n- Git\n\nThen:\n\n1. Install `xk6`:\n  ```shell\n  $ go install go.k6.io/xk6/cmd/xk6@latest\n  ```\n\n2. Build the binary:\n  ```shell\n  $ xk6 build --with github.com/grafana/xk6-notification@latest\n  ```\n\n## Usage\n\n```javascript\nimport http from 'k6/http';\nimport notification from 'k6/x/notification';\n\nconst url = 'slack://token:token@channel/';\n\nexport function setup() {\n  notification.send(url, 'Starting test');\n}\n\nexport default function () {\n  http.get('http://test.k6.io');\n}\n\nexport function teardown(data) {\n  notification.send(url, 'Finishing test');\n}\n```\n\nToken example ([more information](https://containrrr.dev/shoutrrr/latest/guides/slack/)): `slack://xoxb:123456789012-1234567890123-4mt0t4l1YL3g1T5L4cK70k3N@C001CH4NN3L`\n\n## Documentation\n\nFor a full documentation of the api and how to use it, see the [official shoutrrr documentation](https://containrrr.dev/shoutrrr).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrafana%2Fxk6-notification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrafana%2Fxk6-notification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrafana%2Fxk6-notification/lists"}