Create Webhook

Creates a new webhook

post

Query parameters

selectstringOptional

RQL select statements

Body

application/jsontext/jsonapplication/*+json

typeall ofOptional

string · enumOptionalPossible values:

descriptionstring | nullableOptional

urlstring · uriRequired

secretstring | nullableOptional

Responses

201

Created

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

post

HTTPcURLJavaScriptPython

POST /public/v1/notifications/webhooks HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "type": "text",
  "description": "text",
  "url": "https://example.com",
  "criteria": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "secret": "text"
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-07-19T00:51:15.018Z",
      "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-19T00:51:15.018Z",
      "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-19T00:51:15.018Z",
    "responseTime": "2025-07-19T00:51:15.018Z",
    "headers": "text",
    "error": "text",
    "response": "text",
    "reasonPhrase": "text",
    "httpStatusCode": "text"
  },
  "lastFailure": {
    "success": true,
    "callTime": "2025-07-19T00:51:15.018Z",
    "responseTime": "2025-07-19T00:51:15.018Z",
    "headers": "text",
    "error": "text",
    "response": "text",
    "reasonPhrase": "text",
    "httpStatusCode": "text"
  },
  "lastCall": {
    "success": true,
    "callTime": "2025-07-19T00:51:15.018Z",
    "responseTime": "2025-07-19T00:51:15.018Z",
    "headers": "text",
    "error": "text",
    "response": "text",
    "reasonPhrase": "text",
    "httpStatusCode": "text"
  }
}