{
  "opencollection": "1.0.0",
  "info": {
    "name": "SonarQube Cloud Web authentication webhooks API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "webhooks",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a Webhook. Requires 'Administer' permission on the specified project.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sonarcloud.io/api/webhooks/create",
            "params": [
              {
                "name": "name",
                "value": "My Webhook",
                "type": "query",
                "description": "Name displayed in the administration console of webhooks"
              },
              {
                "name": "organization",
                "value": "my-org",
                "type": "query",
                "description": "The key of the organization that will own the webhook"
              },
              {
                "name": "project",
                "value": "my_project",
                "type": "query",
                "description": "The key of the project that will own the webhook"
              },
              {
                "name": "secret",
                "value": "your_secret",
                "type": "query",
                "description": "If provided, secret will be used as the key to generate the HMAC hex (lowercase) digest value in the 'X-Sonar-Webhook-HMAC-SHA256' header"
              },
              {
                "name": "url",
                "value": "https://www.google.com/sonar",
                "type": "query",
                "description": "Server endpoint that will receive the webhook payload, for example 'http://my_server/foo'. If HTTP Basic authentication is used, HTTPS is recommended to avoid man in the middle attacks. Example: 'https://myLogin:myPassword@my_server/foo'"
              }
            ]
          },
          "docs": "Create a Webhook. Requires 'Administer' permission on the specified project."
        },
        {
          "info": {
            "name": "Delete a Webhook. Requires 'Administer' permission on the specified project, or global 'Administer' permission.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sonarcloud.io/api/webhooks/delete",
            "params": [
              {
                "name": "webhook",
                "value": "my_project",
                "type": "query",
                "description": "The key of the webhook to be deleted, auto-generated value can be obtained through api/webhooks/create or api/webhooks/list"
              }
            ]
          },
          "docs": "Delete a Webhook. Requires 'Administer' permission on the specified project, or global 'Administer' permission."
        },
        {
          "info": {
            "name": "Get the recent deliveries for a specified project or Compute Engine task. Require 'Administer' permission on the rela...",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sonarcloud.io/api/webhooks/deliveries",
            "params": [
              {
                "name": "ceTaskId",
                "value": "AU-Tpxb--iU5OvuD2FLy",
                "type": "query",
                "description": "Id of the Compute Engine task"
              },
              {
                "name": "componentKey",
                "value": "my-project",
                "type": "query",
                "description": "Key of the project"
              },
              {
                "name": "p",
                "value": "42",
                "type": "query",
                "description": "1-based page number"
              },
              {
                "name": "ps",
                "value": "20",
                "type": "query",
                "description": "Page size. Must be greater than 0 and less than 500"
              },
              {
                "name": "webhook",
                "value": "AU-TpxcA-iU5OvuD2FLz",
                "type": "query",
                "description": "Key of the webhook that triggered those deliveries, auto-generated value that can be obtained through api/webhooks/create or api/webhooks/list"
              }
            ]
          },
          "docs": "Get the recent deliveries for a specified project or Compute Engine task. Require 'Administer' permission on the related project. Note that additional information are returned by api/webhooks/delivery."
        },
        {
          "info": {
            "name": "Get a webhook delivery by its id. Note that additional information are returned by api/webhooks/delivery.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sonarcloud.io/api/webhooks/delivery",
            "params": [
              {
                "name": "deliveryId",
                "value": "AU-TpxcA-iU5OvuD2FL3",
                "type": "query",
                "description": "Id of delivery"
              }
            ]
          },
          "docs": "Get a webhook delivery by its id. Note that additional information are returned by api/webhooks/delivery."
        },
        {
          "info": {
            "name": "Search for global webhooks or project webhooks. Webhooks are ordered by name. Requires 'Administer' permission on the...",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sonarcloud.io/api/webhooks/list",
            "params": [
              {
                "name": "organization",
                "value": "my-org",
                "type": "query",
                "description": "Organization key"
              },
              {
                "name": "project",
                "value": "my_project",
                "type": "query",
                "description": "Project key"
              }
            ]
          },
          "docs": "Search for global webhooks or project webhooks. Webhooks are ordered by name. Requires 'Administer' permission on the specified project, or global 'Administer' permission."
        },
        {
          "info": {
            "name": "Update a Webhook. Requires 'Administer' permission on the specified project, or global 'Administer' permission.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sonarcloud.io/api/webhooks/update",
            "params": [
              {
                "name": "name",
                "value": "My Webhook",
                "type": "query",
                "description": "new name of the webhook"
              },
              {
                "name": "secret",
                "value": "your_secret",
                "type": "query",
                "description": "If provided, secret will be used as the key to generate the HMAC hex (lowercase) digest value in the 'X-Sonar-Webhook-HMAC-SHA256' header. If blank, any secret previously configured will be removed. If not set, the secret will remain unchanged."
              },
              {
                "name": "url",
                "value": "https://www.google.com/sonar",
                "type": "query",
                "description": "new url to be called by the webhook"
              },
              {
                "name": "webhook",
                "value": "my_project",
                "type": "query",
                "description": "The key of the webhook to be updated, auto-generated value can be obtained through api/webhooks/create or api/webhooks/list"
              }
            ]
          },
          "docs": "Update a Webhook. Requires 'Administer' permission on the specified project, or global 'Administer' permission."
        }
      ]
    }
  ],
  "bundled": true
}