Get the List of all Webhook Subscriptions

JFrog REST APIs
Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Returns all the configured Webhook subscriptions.

Security: Requires a valid admin user.

Usage: GET event/api/v1/subscriptions

Produces: application/json

Sample Output:

[
  {
    "key": "QaAudit",
    "description": "Triggers QA audit when a new artifact is created",
    "enabled": true,
    "event_filter": {
      "domain": "artifact",
      "event_types": [
        "deployed"
      ],
      "criteria": {
        "anyLocal": true,
        "anyRemote": false,
        "includePatterns": [],
        "excludePatterns": [],
        "repoKeys": []
      }
    },
    "handlers": [
      {
        "handler_type": "webhook",
        "url": "https://qa.my-company.test/",
        "secret": "tell no one",
        "proxy": "mainProxy",
        "custom_http_headers": [
          {
            "name": "X-MyCompany-Header",
            "value": "whatever"
          }
        ]
      }
    ]
  },
  {
    "key": "SecurityAudit",
    "description": "Triggers Security audit when a new artifact is deployed",
    "enabled": true,
    "event_filter": {
      "domain": "artifact",
      "event_types": [
        "deployed"
      ],
      "criteria": {
        "anyLocal": true,
        "anyRemote": false,
        "includePatterns": [],
        "excludePatterns": [],
        "repoKeys": []
      }
    },
    "handlers": [
      {
        "handler_type": "webhook",
        "url": "https://security.my-company.test/",
        "secret": "hush hush"
      }
    ]
  }
]

Parameter

Description

url

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

secret

Defines a secret authentication token that will be sent to the configured URL.

proxy

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

custom_http_headers

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

criteria

Specifies where the webhook will be applied, on which builds and repositories.

Note: The supported format of includePatterns and excludePatterns is ANT pattern.

Response Codes:

  • 200 List successfully provided