Update Webhook

Updates webhook.

put
Path parameters
idstringRequired

Id of webhook to update

Query parameters
selectstringOptional

RQL select statements

Body
webhookIdstringOptional
descriptionall ofOptional
urlall ofOptional
criteriaall ofOptional
secretall ofOptional
Responses
200
OK
application/json
put
PUT /public/v1/notifications/webhooks/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "webhookId": "text",
  "description": {
    "value": "text"
  },
  "url": {
    "value": "https://example.com"
  },
  "criteria": {
    "value": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "secret": {
    "value": "text"
  }
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-07-19T08:39:16.840Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "updated": {
      "at": "2025-07-19T08:39:16.840Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "url": "text",
  "description": "text",
  "status": "text",
  "type": "text",
  "secret": "text",
  "statistics": {
    "total": 1,
    "successes": 1,
    "failures": 1,
    "failuresSinceLastSuccess": 1
  },
  "objectType": "text",
  "account": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "name": "text"
  },
  "object": {
    "id": "text",
    "name": "text",
    "icon": "text"
  },
  "criteria": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "lastSuccess": {
    "success": true,
    "callTime": "2025-07-19T08:39:16.840Z",
    "responseTime": "2025-07-19T08:39:16.840Z",
    "headers": "text",
    "error": "text",
    "response": "text",
    "reasonPhrase": "text",
    "httpStatusCode": "text"
  },
  "lastFailure": {
    "success": true,
    "callTime": "2025-07-19T08:39:16.840Z",
    "responseTime": "2025-07-19T08:39:16.840Z",
    "headers": "text",
    "error": "text",
    "response": "text",
    "reasonPhrase": "text",
    "httpStatusCode": "text"
  },
  "lastCall": {
    "success": true,
    "callTime": "2025-07-19T08:39:16.840Z",
    "responseTime": "2025-07-19T08:39:16.840Z",
    "headers": "text",
    "error": "text",
    "response": "text",
    "reasonPhrase": "text",
    "httpStatusCode": "text"
  }
}

Last updated

Was this helpful?