Update Webhook Subscription by Key

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Updates the Webhook subscription with a given key.

Security: Requires a valid admin user.

Usage: PUT event/api/v1/subscriptions/{key}

Produces: application/json

Sample Input:

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

Response Codes:

  • 204 Success of update (no content)

  • 400 Bad input

  • 404 Subscription does not exist