{"id":17643460,"url":"https://github.com/carmenmitru/wdio-slack-service","last_synced_at":"2025-04-30T07:49:35.992Z","repository":{"id":38293776,"uuid":"229266625","full_name":"carmenmitru/wdio-slack-service","owner":"carmenmitru","description":"A WebdriverIO service which sends notifications of test results to Slack.","archived":false,"fork":false,"pushed_at":"2023-01-27T05:11:36.000Z","size":357,"stargazers_count":4,"open_issues_count":21,"forks_count":19,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-30T07:49:24.353Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/carmenmitru.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-20T13:06:19.000Z","updated_at":"2023-12-09T02:58:59.000Z","dependencies_parsed_at":"2023-02-15T06:00:53.692Z","dependency_job_id":null,"html_url":"https://github.com/carmenmitru/wdio-slack-service","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carmenmitru%2Fwdio-slack-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carmenmitru%2Fwdio-slack-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carmenmitru%2Fwdio-slack-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carmenmitru%2Fwdio-slack-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/carmenmitru","download_url":"https://codeload.github.com/carmenmitru/wdio-slack-service/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251666226,"owners_count":21624290,"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":[],"created_at":"2024-10-23T09:04:50.768Z","updated_at":"2025-04-30T07:49:35.969Z","avatar_url":"https://github.com/carmenmitru.png","language":"JavaScript","funding_links":[],"categories":["Plugins"],"sub_categories":["Services"],"readme":"# Webdriverio Slack Service\nWebdriverio library to send test results as a slack notification/message to channels\n\n## Installation\n\nThe easiest way is to keep `wdio-slack-service` as a devDependency in your `package.json`.\n\n```json\n{\n  \"devDependencies\": {\n    \"wdio-slack-service\": \"2.0.8\"\n  }\n}\n```\n\nYou can simple do it by:\n\n```bash\nnpm install wdio-slack-service --save-dev\n```\n\nInstructions on how to install `WebdriverIO` can be found [here.](https://webdriver.io/docs/gettingstarted.html)\n\n## Configuration\n\nAt first, import the service to wdio config file `wdio.conf.js`\n\n```js\n// wdio.conf.js\nconst slack = require('wdio-slack-service');\n```\n\nIn order to use the service you need to have slack webhook url to send the notification and you need to add `slack` to your `services` array\n\nExample:\n\n```js\n// wdio.conf.js\nexport.config = {\n    // ...\n    services: [\n        [slack, {\n            webHookUrl: \"\u003cSLACK_WEBHOOK_URL\u003e\", // Used to post notification to a particular channel\n            notifyOnlyOnFailure: true, // Send notification only on test failure\n            messageTitle: \"\u003cNOTIFICATION_TITLE\u003e\" // Name of the notification\n        }]\n]\n```\n## Features\n\n- Send notification irrespective of test results\n- Send notification only on test failure\n- Support for `mocha`, `jasmine` and `cucumber`\n- Retry/Rerun tests will be logged with addional info\n- Test duration info\n- Error details\n- Cucumber scenario/step reporting\n- Browser and Version info\n\n## How it works\nFor `mocha`/`jasmine`, notification will be sent on spec level and for `cucumber`, it will be on feature level. Let's say, if you have 10 spec/feature files, you will receive 10 notifications as it is triggered in `after` hook\n\n## Options\n\nTo send a notification, you should have slack webhook url. To know how to create slack webhook URL, see this [page](https://api.slack.com/messaging/webhooks)\n\n### webHookUrl\n\nThis url is used to identity/authenticate the post message and sends it to a slack channel\n\nType: `String` \u003cbr/\u003e\nOptional: `NO` \u003cbr/\u003e\nDefault: `NA`\n\n### notifyOnlyOnFailure\n\nIf you want to receive slack notifications only on test failure, then set this option to `true`. Otherwise, it sends notification for all test executions irrespective of pass/fail\n\nType: `Boolean` \u003cbr/\u003e\nOptional: `YES` \u003cbr/\u003e\nDefault: `false`\n\n### messageTitle\n\nTitle of the notification\n\nType: `String` \u003cbr/\u003e\nOptional: `YES` \u003cbr/\u003e\nDefault: `Webdriverio Slack Reporter`\n\n## Screenshots\n\n### Cucumber Pass/Fail\n\n![Cucumber Pass/fail](/assets/Cucumber.PNG)\n\n### Cucumber Retry\n\n![Cucumber Retry](/assets/Cucumberretry.PNG)\n\n### All Pass\n\n![All Pass](/assets/allpass.PNG)\n\n### Fail Pass\n\n![Fail Pass](/assets/failpass.PNG)\n\n### Retry Failed\n\n![Retry Failed](/assets/retryfail.PNG)\n\n### Retry Passed\n\n![Retry Passed](/assets/retrypassed.PNG)\n\n---\n\nFor more information on WebdriverIO see the [homepage](https://webdriver.io).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarmenmitru%2Fwdio-slack-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcarmenmitru%2Fwdio-slack-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarmenmitru%2Fwdio-slack-service/lists"}