Create Webhook

Creates a new webhook

post
Query parameters
selectstringOptional

RQL select statements

Body
typeall ofOptional
string · enumOptionalPossible values:
descriptionstring | nullableOptional
urlstring · uriRequired
secretstring | nullableOptional
Responses
201
Created
application/json
post
POST /public/v1/notifications/webhooks HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "type": "text",
  "description": "text",
  "url": "https://example.com",
  "criteria": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "secret": "text"
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-22T14:56:03.174Z",
      "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-06-22T14:56:03.174Z",
      "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": "text",
    "status": "text",
    "name": "text"
  },
  "object": {
    "id": "text",
    "name": "text",
    "icon": "text"
  },
  "criteria": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "lastSuccess": {
    "success": true,
    "callTime": "2025-06-22T14:56:03.174Z",
    "responseTime": "2025-06-22T14:56:03.174Z",
    "headers": "text",
    "error": "text",
    "response": "text",
    "reasonPhrase": "text",
    "httpStatusCode": "text"
  },
  "lastFailure": {
    "success": true,
    "callTime": "2025-06-22T14:56:03.174Z",
    "responseTime": "2025-06-22T14:56:03.174Z",
    "headers": "text",
    "error": "text",
    "response": "text",
    "reasonPhrase": "text",
    "httpStatusCode": "text"
  },
  "lastCall": {
    "success": true,
    "callTime": "2025-06-22T14:56:03.174Z",
    "responseTime": "2025-06-22T14:56:03.174Z",
    "headers": "text",
    "error": "text",
    "response": "text",
    "reasonPhrase": "text",
    "httpStatusCode": "text"
  }
}

Last updated

Was this helpful?