/r/{repoId}/events/{id}/{webHookId}

{
  "apiKey": {
    "type": "string",
    "description": "Authentication key that can be sent to the webhook.",
    "nullable": true,
    "example": "cryptoKey"
  },
  "description": {
    "minLength": 1,
    "type": "string",
    "description": "A freely selectable description of the webhook. Used only as a summary and description.",
    "example": "Webhook for the validation of invoices."
  },
  "enabled": {
    "type": "boolean",
    "description": "Indicates whether a webhook is to be executed. Webhooks that are not executed remain stored in the system.",
    "default": false
  },
  "handleResponse": {
    "minLength": 1,
    "type": "string",
    "description": "Indicates how the HTTP response returned by the webhook is processed.\r\nNONE: Response is not processed.\r\nSTATUS: Only the status code of the HTTP response is evaluated.\r\nSTATUS_AND_BODY: The status code and response body are evaluated.",
    "example": "NONE | STATUS | STATUS_AND_BODY"
  },
  "id": {
    "type": "string",
    "description": "The unique ID of the webhook.",
    "nullable": true,
    "readOnly": true,
    "example": "00000000-0000-0000-0000-000000000000"
  },
  "restrictions": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "description": "As the key, you can currently specify only CATEGORY to filter for one category or more categories.",
          "nullable": true,
          "example": "CATEGORY"
        },
        "value": {
          "type": "string",
          "description": "The ID of the category.",
          "nullable": true,
          "example": "00000000-0000-0000-0000-000000000000"
        }
      },
      "additionalProperties": false,
      "description": "The restriction object describes a filter that defines the documents and dossiers for which this webhook is to be executed."
    },
    "description": "Filters that you can use to define the categories for which this webhook is to be executed. If you do not make an entry, the webhook is executed for all categories.",
    "nullable": true
  },
  "retry": {
    "type": "boolean",
    "description": "Indicates whether a webhook should be executed again for up to three times in case of a timeout or an incorrect answer.",
    "default": true,
    "nullable": true
  },
  "timeout": {
    "type": "integer",
    "description": "Time in milliseconds after which a timeout is assumed.",
    "format": "int32",
    "default": 300,
    "nullable": true
  },
  "uri": {
    "minLength": 1,
    "type": "string",
    "description": "URI to be activated when the webhook is executed. Must be a valid HTTP(S) URI. Relative URIs begin with a slash.",
    "example": "https://my-company.com/webhooks"
  }
}

{
  "apiKey": {
    "type": "string",
    "description": "Authentication key that can be sent to the webhook.",
    "nullable": true,
    "example": "cryptoKey"
  },
  "description": {
    "minLength": 1,
    "type": "string",
    "description": "A freely selectable description of the webhook. Used only as a summary and description.",
    "example": "Webhook for the validation of invoices."
  },
  "enabled": {
    "type": "boolean",
    "description": "Indicates whether a webhook is to be executed. Webhooks that are not executed remain stored in the system.",
    "default": false
  },
  "handleResponse": {
    "minLength": 1,
    "type": "string",
    "description": "Indicates how the HTTP response returned by the webhook is processed.\r\nNONE: Response is not processed.\r\nSTATUS: Only the status code of the HTTP response is evaluated.\r\nSTATUS_AND_BODY: The status code and response body are evaluated.",
    "example": "NONE | STATUS | STATUS_AND_BODY"
  },
  "id": {
    "type": "string",
    "description": "The unique ID of the webhook.",
    "nullable": true,
    "readOnly": true,
    "example": "00000000-0000-0000-0000-000000000000"
  },
  "restrictions": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "description": "As the key, you can currently specify only CATEGORY to filter for one category or more categories.",
          "nullable": true,
          "example": "CATEGORY"
        },
        "value": {
          "type": "string",
          "description": "The ID of the category.",
          "nullable": true,
          "example": "00000000-0000-0000-0000-000000000000"
        }
      },
      "additionalProperties": false,
      "description": "The restriction object describes a filter that defines the documents and dossiers for which this webhook is to be executed."
    },
    "description": "Filters that you can use to define the categories for which this webhook is to be executed. If you do not make an entry, the webhook is executed for all categories.",
    "nullable": true
  },
  "retry": {
    "type": "boolean",
    "description": "Indicates whether a webhook should be executed again for up to three times in case of a timeout or an incorrect answer.",
    "default": true,
    "nullable": true
  },
  "timeout": {
    "type": "integer",
    "description": "Time in milliseconds after which a timeout is assumed.",
    "format": "int32",
    "default": 300,
    "nullable": true
  },
  "uri": {
    "minLength": 1,
    "type": "string",
    "description": "URI to be activated when the webhook is executed. Must be a valid HTTP(S) URI. Relative URIs begin with a slash.",
    "example": "https://my-company.com/webhooks"
  }
}