{"id":20976924,"url":"https://github.com/pixelbrackets/give-notice","last_synced_at":"2025-06-14T09:37:23.114Z","repository":{"id":145819634,"uuid":"299717786","full_name":"pixelbrackets/give-notice","owner":"pixelbrackets","description":"Send a request to a preset URI and don’t expect a response","archived":false,"fork":false,"pushed_at":"2020-09-30T19:38:10.000Z","size":56,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-06T18:29:37.834Z","etag":null,"topics":["notice","notification","php","request","tracker"],"latest_commit_sha":null,"homepage":"https://gitlab.com/pixelbrackets/give-notice/","language":"PHP","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/pixelbrackets.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"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-09-29T19:28:07.000Z","updated_at":"2020-11-13T14:58:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"7814f080-c86c-4cdd-9197-1fde500e4425","html_url":"https://github.com/pixelbrackets/give-notice","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelbrackets%2Fgive-notice","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelbrackets%2Fgive-notice/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelbrackets%2Fgive-notice/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixelbrackets%2Fgive-notice/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pixelbrackets","download_url":"https://codeload.github.com/pixelbrackets/give-notice/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243381195,"owners_count":20281912,"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":["notice","notification","php","request","tracker"],"created_at":"2024-11-19T04:56:21.756Z","updated_at":"2025-03-13T09:37:43.742Z","avatar_url":"https://github.com/pixelbrackets.png","language":"PHP","readme":"# Give Notice\n\n![Logo](docs/icon.png)\n\n[![Version](https://img.shields.io/packagist/v/pixelbrackets/give-notice.svg?style=flat-square)](https://packagist.org/packages/pixelbrackets/give-notice/)\n[![Build Status](https://img.shields.io/gitlab/pipeline/pixelbrackets/give-notice?style=flat-square)](https://gitlab.com/pixelbrackets/give-notice/pipelines)\n[![Made With](https://img.shields.io/badge/made_with-php-blue?style=flat-square)](https://gitlab.com/pixelbrackets/give-notice#requirements)\n[![License](https://img.shields.io/badge/license-gpl--2.0--or--later-blue.svg?style=flat-square)](https://spdx.org/licenses/GPL-2.0-or-later.html)\n[![Contribution](https://img.shields.io/badge/contributions_welcome-%F0%9F%94%B0-brightgreen.svg?labelColor=brightgreen\u0026style=flat-square)](https://gitlab.com/pixelbrackets/give-notice/-/blob/master/CONTRIBUTING.md)\n\nSend a request to a preset URI and don’t expect a response.\n\n![Screenshot](./docs/screenshot.png)\n\n## Vision\n\nThe idea of the package is to just “give notice” to another service. When the\nnotification is send, it is not relevant to get any feedback.\n\nThis package provides a static method to sends requests to a preset URI.\n\nThe URI is configured with an environment variable and therefore separated\nfrom application code.\n\nThe app calling the method does not need or want a response.\n\nThe method is silent. The request timeout of the method is very low by default.\n\nUse cases:\n- Send a heartbeat to another service, to \n  [push instead of polling](https://resthooks.org/), but yet don't reverse\n  responsibilities to react to unavailability\n- Ping a tracking service whenever a certain API endpoint was called,\n  [limit the timeout and discard any response](https://stackoverflow.com/questions/14359926/send-http-request-from-php-without-waiting-for-response),\n  because under heavy load it is more important to keep a fast API than \n  loosing some tracking requests\n- Notify an unimportant service or be absolutely positive the message will\n  receive its target and do not block the app unnecessarily\n\nSee [»Usage«](#usage) for an example.\n\nThe package follows the KISS principle.\n\n## Requirements\n\n- PHP\n\n## Installation\n\nPackagist Entry https://packagist.org/packages/pixelbrackets/give-notice/\n\n## Source\n\nhttps://gitlab.com/pixelbrackets/give-notice/\n\nMirror https://github.com/pixelbrackets/give-notice/\n\n## Usage\n\nSet an environment variable to preset a URI to call later on.\n\n```bash\nGIVENOTICE_URI='https://example.com/endpoint/11azqde1'\n```\n\n1. Send a request straightaway\n   ```php\n   \\Pixelbrackets\\GiveNotice\\Notification::push();\n   ```\n\n☝️ Be aware that the static notification object is silent by design. It returns\nnothing and catches exceptions, such as connection errors. If the notified \nservice is not available then your app will not hear about it. Instead, \nthe service needs to monitor and react to overdue messages.\n\n## License\n\nGNU General Public License version 2 or later\n\nThe GNU General Public License can be found at http://www.gnu.org/copyleft/gpl.html.\n\n## Author\n\nDan Untenzu (\u003cmail@pixelbrackets.de\u003e / [@pixelbrackets](https://pixelbrackets.de))\n\n## Changelog\n\nSee [./CHANGELOG.md](CHANGELOG.md)\n\n## Contribution\n\nThis script is Open Source, so please use, patch, extend or fork it.\n\n[Contributions](CONTRIBUTING.md) are welcome!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixelbrackets%2Fgive-notice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpixelbrackets%2Fgive-notice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixelbrackets%2Fgive-notice/lists"}