Webhooks

A webhook is a POST request sent to a URL that you define in Docker Hub or another registry. Use webhooks to trigger an action in response to an event such as a repository push.
Webhooks are only available on non-Edge environments (environments running Portainer Server or Portainer Agent, not the Portainer Edge Agent). This is because the tunnel to the Portainer Edge Agent is only opened on-demand, and therefore would mean there is no way to expose a webhook permanently.
Enabling a stack webhook
From the menu select Stacks then select the container that you want to configure the webhook for. Then select the Edit tab.
Scroll down to the Webhooks section and toggle the Create a stack webhook option on. When the URL appears, click Copy link. This URL will be used to configure the webhook in your chosen registry.
This example shows how to trigger the webhook using redeploy:
1
<form action="https://portainer:9443/api/stacks/webhooks/638e6967-ef77-4906-8af8-236800621360" method="post">
2
  Redeploy stack containers with latest image of same tag <input type="submit" />
3
</form>
Copied!
This example shows how to trigger the webhook to update the stack to use a different image tag:
1
<form action="https://portainer:9443/api/stacks/webhooks/638e6967-ef77-4906-8af8-236800621360?tag=latest" method="post">
2
  Update stack container images with different tag <input type="submit" />
3
</form>
Copied!
Using environment variables with webhooks
When triggering a webhook, environment variables can be passed through the endpoint and referenced within stacks' compose files.
To specify an environment variable on a webhook, add it as a variable to the URL. For example, to pass a SERVICE_TAG variable with the value development:
1
https://portainer:9443/api/stacks/webhooks/1d251d96-fb34-4172-a0a1-d0655467b897?SERVICE_TAG=development
Copied!
To reference the SERVICE_TAG variable in your compose file with a fallback to the value stable:
1
services:
2
  my-service:
3
    image: repository/image:${SERVICE_TAG:-stable}
Copied!
Configuring the webhook in Docker Hub
To finish the configuration, refer to Docker's own documentation.

Create a template from a deployed stack

Migrate or duplicate a stack

Last modified 9d ago

Copy link

Edit on GitHub

Contents

Enabling a stack webhook

Using environment variables with webhooks

Configuring the webhook in Docker Hub