{"id":13558835,"url":"https://github.com/nickstenning/dokku-webhooks","last_synced_at":"2025-07-06T20:07:57.944Z","repository":{"id":27941160,"uuid":"31433731","full_name":"nickstenning/dokku-webhooks","owner":"nickstenning","description":"A dokku plugin for triggering external webhooks.","archived":false,"fork":false,"pushed_at":"2017-03-17T21:16:59.000Z","size":11,"stargazers_count":24,"open_issues_count":1,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-05T14:52:42.617Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/nickstenning.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}},"created_at":"2015-02-27T18:44:17.000Z","updated_at":"2022-05-19T18:15:18.000Z","dependencies_parsed_at":"2022-07-27T11:32:28.171Z","dependency_job_id":null,"html_url":"https://github.com/nickstenning/dokku-webhooks","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nickstenning/dokku-webhooks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickstenning%2Fdokku-webhooks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickstenning%2Fdokku-webhooks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickstenning%2Fdokku-webhooks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickstenning%2Fdokku-webhooks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nickstenning","download_url":"https://codeload.github.com/nickstenning/dokku-webhooks/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickstenning%2Fdokku-webhooks/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263966169,"owners_count":23536814,"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-08-01T12:05:11.056Z","updated_at":"2025-07-06T20:07:57.925Z","avatar_url":"https://github.com/nickstenning.png","language":"Shell","funding_links":[],"categories":["Shell","others"],"sub_categories":[],"readme":"# dokku-webhooks\n\ndokku-webhooks is a plugin for [dokku](https://github.com/progrium/dokku) that\ntriggers external [webhooks](https://en.wikipedia.org/wiki/Webhook) in response\nto build/deployment stages.\n\n## Installation\n\n\n```shell\n# dokku 0.4.x+\nsudo dokku plugin:install https://github.com/nickstenning/dokku-webhooks.git\n\n# dokku 0.3\ngit clone https://github.com/nickstenning/dokku-webhooks.git /var/lib/dokku/plugins/webhooks\ngit reset --hard c5ade98a8e188ccd9f1f544e3ffc8c1d5d0ea4e0\n```\n\nNext, move the `receive-app` hook out of the way:\n\n```shell\nmv /var/lib/dokku/plugins/git/receive-app /var/lib/dokku/plugins/git/receive-app.bak\n```\n\nThe second step is necessary because this plugin replaces the default\n`receive-app` hook. If you don't use the default git `receive-app` hook then you\nwill need to modify the last lines of `receive-app` in this plugin accordingly.\n\n## Configuration\n\nAdd a webhook:\n\n    dokku webhooks:add https://example.com/my/webhook\n\nRemove a webhook:\n\n    dokku webhooks:remove https://example.com/my/webhook\n\nList all installed webhooks:\n\n    dokku webhooks\n\n## Hooks\n\nEach webhook endpoint is sent an HTTP POST request with a standard\n`application/x-www-form-urlencoded` POST payload, the contents of which depend\non which stage of deployment has been reached.\n\nAll hook requests contain the following POST params:\n\nParam            | Example value        | Description\n---------------- | -------------------- | ------------------------------\n`action`         | `receive-app`        | The deployment stage.\n`hostname`       | `dokku.example.com`  | The FQDN of the dokku host.\n`app`            | `mywebapp`           | The dokku app being deployed.\n\nOther hook requests contain additional data, as detailed below.\n\n### `receive-app`\n\nThis hook is triggered at the very start of a deployment, when dokku starts\nreceiving data pushed to git.\n\nParam            | Example value                              | Description\n---------------- | ------------------------------------------ | ----------------------------------------------------------------------------\n`git_rev`        | `ade8218956d4a744ca42f872700384124edf015b` | The git revision being deployed.\n`git_rev_before` | `0000000000000000000000000000000000000000` | The git revision currently deployed, or `0{40}` if this is the first deploy.\n\n### `post-deploy`\n\nThis hook is triggered at the very end of a successful deployment.\n\nParam            | Example value                         | Description\n---------------- | ------------------------------------- | ------------------------------------------------\n`internal_ip`    | `127.0.0.1`                           | The internal IP on which the app is listening.\n`internal_port`  | `49152`                               | The internal port on which the app is listening.\n`url`            | `https://mywebapp.dokku.example.com`  | The public URL of the deployed app.\n\n## License\n\nThis free software is released under the MIT license, a copy of which can be\nfound in `LICENSE`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickstenning%2Fdokku-webhooks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnickstenning%2Fdokku-webhooks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickstenning%2Fdokku-webhooks/lists"}