Files
docker-docs/docker-hub/webhooks.md
cloud_melon 71471c54a4 Clarify the webhook's definiton in webhooks.md (#6243)
* Clarify the webhook's definiton in webhooks.md

Here is necessary to clarify the real definition of webhook which is a request with POST action to a specified url ( when this happen, the url going to return the result, in this context, is when we do 'docker push'  to submit a image to registry, it fires the automatically build

* Updated after suggest 

I updated the right sentence, I feel it more clear now. thank you :)

* Remove duplicate wording
2018-03-30 14:15:20 -07:00

2.4 KiB

description, keywords, title
description keywords title
Docker Hub Automated Builds Docker, webhookds, hub, builds Webhooks for automated builds

If you have an automated build repository in Docker Hub, you can use Webhooks to cause an action in another application in response to an event in the repository. Webhook is a POST request sent to a defined URL which provides the service. Docker Hub webhooks fire when an image is built in, or a new tag is added to, your automated build repository.

Configure webhooks on https://hub.docker.com/r/<USERNAME>/<REPOSITORY>/~/settings/webhooks/.

Create Webhook

With your webhook, you specify a target URL to POST to. Docker Hub POSTs the URL with the following payload:

{
  "callback_url": "https://registry.hub.docker.com/u/svendowideit/testhook/hook/2141b5bi5i5b02bec211i4eeih0242eg11000a/",
  "push_data": {
    "images": [
        "27d47432a69bca5f2700e4dff7de0388ed65f9d3fb1ec645e2bc24c223dc1cc3",
        "51a9c7c1f8bb2fa19bcd09789a34e63f35abb80044bc10196e304f6634cc582c",
        "..."
    ],
    "pushed_at": 1.417566161e+09,
    "pusher": "trustedbuilder",
    "tag": "latest"
  },
  "repository": {
    "comment_count": "0",
    "date_created": 1.417494799e+09,
    "description": "",
    "dockerfile": "#\n# BUILD\u0009\u0009docker build -t svendowideit/apt-cacher .\n# RUN\u0009\u0009docker run -d -p 3142:3142 -name apt-cacher-run apt-cacher\n#\n# and then you can run containers with:\n# \u0009\u0009docker run -t -i -rm -e http_proxy http://192.168.1.2:3142/ debian bash\n#\nFROM\u0009\u0009ubuntu\n\n\nVOLUME\u0009\u0009[\/var/cache/apt-cacher-ng\]\nRUN\u0009\u0009apt-get update ; apt-get install -yq apt-cacher-ng\n\nEXPOSE \u0009\u00093142\nCMD\u0009\u0009chmod 777 /var/cache/apt-cacher-ng ; /etc/init.d/apt-cacher-ng start ; tail -f /var/log/apt-cacher-ng/*\n",
    "full_description": "Docker Hub based automated build from a GitHub repo",
    "is_official": false,
    "is_private": true,
    "is_trusted": true,
    "name": "testhook",
    "namespace": "svendowideit",
    "owner": "svendowideit",
    "repo_name": "svendowideit/testhook",
    "repo_url": "https://registry.hub.docker.com/u/svendowideit/testhook/",
    "star_count": 0,
    "status": "Active"
  }
}

Note

: If you want to test your webhook, we recommend using a tool like requestb.in. Also note, the Docker Hub server can't be filtered by IP address.