{"id":45324427,"url":"https://github.com/jonathangomz/onesignal-client","last_synced_at":"2026-02-21T08:30:26.600Z","repository":{"id":57121940,"uuid":"302499925","full_name":"jonathangomz/onesignal-client","owner":"jonathangomz","description":"Client for OneSignal API","archived":false,"fork":false,"pushed_at":"2020-10-29T22:14:40.000Z","size":62,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-02T07:37:26.191Z","etag":null,"topics":["client-api","nodejs","npm","npm-package","onesignal","onesignal-api"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@jonathangomz/onesignal-client","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/jonathangomz.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":"2020-10-09T01:15:35.000Z","updated_at":"2020-10-29T22:14:42.000Z","dependencies_parsed_at":"2022-08-24T14:57:06.246Z","dependency_job_id":null,"html_url":"https://github.com/jonathangomz/onesignal-client","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/jonathangomz/onesignal-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathangomz%2Fonesignal-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathangomz%2Fonesignal-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathangomz%2Fonesignal-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathangomz%2Fonesignal-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonathangomz","download_url":"https://codeload.github.com/jonathangomz/onesignal-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathangomz%2Fonesignal-client/sbom","scorecard":{"id":530300,"data":{"date":"2025-08-11","repo":{"name":"github.com/jonathangomz/onesignal-client","commit":"d6ddd596c67ac2d7cdeb7bce82408d9182bb670a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/jonathangomz/onesignal-client/tests.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/jonathangomz/onesignal-client/tests.yml/main?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/tests.yml:22","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/tests.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-20T05:31:42.777Z","repository_id":57121940,"created_at":"2025-08-20T05:31:42.777Z","updated_at":"2025-08-20T05:31:42.777Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29677492,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T06:23:40.028Z","status":"ssl_error","status_checked_at":"2026-02-21T06:23:39.222Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["client-api","nodejs","npm","npm-package","onesignal","onesignal-api"],"created_at":"2026-02-21T08:30:26.137Z","updated_at":"2026-02-21T08:30:26.594Z","avatar_url":"https://github.com/jonathangomz.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OneSignal Client for Nodejs\nA OneSignal client that implement some of the endpoints from the OneSignal API\n\n## Docs\n**Note: The responses are the direct responses from the provider so you can see the examples on his documentation ([See ref](#ref)).**\n\n### `constructor({ authKey, restApiKey, appId })`\nCreates a new OneSignal client.\n```js\nconst client = new OneSignal({\n  authKey: process.env.AUTH_KEY,\n  restApiKey: process.env.REST_API_KEY,\n  appId: process.env.APP_ID,\n});\n```\n### `isValid(): Promise\u003cboolean | Error\u003e`\nValidate that the app exist in the provider.\n```js\nclient.isValid()\n```\n### `getApp(): Promise\u003cResponse\u003e`\nView the details of a single OneSignal app.\n\n[_See more_][1]\n\n**Usage example:**\n```js\nclient.getApp()\n```\n### `sendNotification(message, options?): Promise\u003cResponse\u003e`\nSends notifications to your users. \\\n_If attribute `included_segments` not provided will send to \"Test\" segment by default_.\n\n[_See more_][2]\n\n**Usage example:**\n```js\nconst message = {\n  heading: {\n    en: 'Example Explicit Segment',\n    es: 'Ejemplo Segmento Explicito',\n  },\n  content: {\n    en: 'This is an example for Test segment explicitly',\n    es: 'Este es un ejemplo para el segmento Test de forma explícita',\n  }\n}\n\nconst opt = {\n  targets: {\n    to: {\n      type: 'external',\n      value: ['1130745'],\n    }\n  }\n}\n\nclient.sendNotification(message, opt);\n```\n### `cancelNotification(notification_id): Promise\u003cResponse\u003e`\nStop a scheduled or currently outgoing notification.\n\n[_See more_][3]\n\n**Usage example:**\n```js\nclient.cancelNotification('fd1723c6-bfaf-4f53-b4f4-0408ff43e18a');\n```\n### `viewNotifications(options?): Promise\u003cResponse\u003e`\nView the details of multiple notifications.\n\n[_See more_][4]\n\n**Usage example:**\n```js\nclient.viewNotifications({ limit: 5 });\n```\n### `viewNotification(notification_id): Promise\u003cResponse\u003e`\nView the details of a single notification and outcomes associated with it.\n\n[_See more_][5]\n\n**Usage example:**\n```js\nclient.viewNotification('fd1723c6-bfaf-4f53-b4f4-0408ff43e18a');\n```\n### `viewDevices(options?): Promise\u003cResponse\u003e`\nView the details of multiple devices in your app.\n\n[_See more_][6]\n\n**Usage example:**\n```js\nclient.viewDevices({ limit: 2 });\n```\n### `viewDevice(player_id): Promise\u003cResponse\u003e`\nView the details of an existing device in your OneSignal apps.\n\n[_See more_][7]\n\n**Usage example:**\n```js\nclient.viewDevice('fd1723c6-bfaf-4f53-b4f4-0408ff43e18a');\n```\n\n## Ref:\nhttps://documentation.onesignal.com/reference\n\n[1]:https://documentation.onesignal.com/reference/view-an-app\n[2]:https://documentation.onesignal.com/reference/create-notification\n[3]:https://documentation.onesignal.com/reference/cancel-notification\n[4]:https://documentation.onesignal.com/reference/view-notifications\n[5]:https://documentation.onesignal.com/reference/view-notification\n[6]:https://documentation.onesignal.com/reference/view-devices\n[7]:https://documentation.onesignal.com/reference/view-device","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonathangomz%2Fonesignal-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonathangomz%2Fonesignal-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonathangomz%2Fonesignal-client/lists"}