Predefined Webhooks

JFrog Platform Administration Documentation

ft:sourceType
Paligo
  1. Navigate to Administration Module | General | Webhooks and click New Webhook.

    JFrog Cloud New Interface (Beta)

    On the taskbar, click176260902.png(Platform Configurations), and select Platform Management > Webhooks. To learn more, click here.JFrog Platform New UI (Beta) Quick Start Guide

  2. Enter the details of the following fields.

    Field

    Description

    URL

    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.

    Use Proxy

    Indicates whether to send the Webhook through a proxy. You can select a proxy from the configured proxy servers list.

    Event

    Displays the list of Events in Artifactory, Xray, and Distribution that function as the event trigger for the Webhook.

    Secret Token

    Defines a secret authentication token. As an admin, you can determine the way in which the webhook's secret token should be used:

    • Use the secret authentication token as the “X-JFrog-Event-Auth” HTTP header, so that the token can be used by the service that receives the event to authenticate the event emitter

    • Used to sign the events payload - in which case the secret token it must not be passed as a header

    Use secret for payload signing

    If the checkbox "Use secret for payload signing" is selected, the secret will be used to sign the events payload and will be passed as the “X-JFrog-Event-Auth” HTTP header".

    Warning

    Note that custom http headers cannot be trusted on the webhook target side - because, since they are not signed, they can be tampered with by any man-in-the-middle.

    Custom Headers

    Adds custom headers you wish to use to invoke the Webhook.

    Note

    By default, private networks are not allowed to be used as Webhook targets for security reasons. If you would like to allow use of a private network, change the URL strict policy configuration in the system.yaml file: urlStrictPolicy: true. See Artifactory System YAML.Artifactory System YAML

  3. Some events can be applied to repositories, builds, and Release Bundles.

    Events such as artifact was deployed, moved, added can be applied on every repository in Artifactory or on a list of specific repositories, based on a specific list or by using include/exclude patterns.

    Note

    Note that if you select any local and/or remote repository, the Webhook will be applied on all existing repositories and any repositories you create in the future.

    image2020-6-21_14-1-31.png

    Events such as build was deployed, promoted, deleted can be applied on every new build that is uploaded to Artifactory or on a list of specific builds, based on a specific list or by using include/exclude patterns.

    image2020-6-21_14-2-32.png

    Release Bundle and Distribution events can be applied on every new Release Bundle or on a list of specific Release Bundles, based on a specific list or by using include/exclude patterns.

    Exclude:Include Patterns in Webhooks Build Page.png