Add a new webhook

POST /api/dw/webhook

Session token Jwt token internal Login config

Query parameters

iw-build-id string

build id of the client
iw-package-id string

package id of the client

application/json

Body Required

data object
Hide data attributes Show data attributes object
- reference_class_name string
- reference_ids string
- database_action string
- notification_type string
- notification_url string
- notification_client_id string
- notification_client_token string
- request_timeout integer
- notification_value_path string
- include_write_permission boolean
- deleted boolean

Responses

200 application/json

Add a new webhook
Hide response attributes Show response attributes object
- reference_class_name string
- reference_ids string
- database_action string
- notification_type string
- notification_url string
- request_timeout integer
- notification_value_path string
- include_write_permission boolean
- created string(date-time)
- updated string(date-time)
- name string
- deleted boolean

POST /api/dw/webhook

curl \
 --request POST 'https://replace-with-own-host.iw-erp.de/api/dw/webhook' \
 --header "x-session-token: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"data":{"reference_class_name":"string","reference_ids":"string","database_action":"string","notification_type":"string","notification_url":"string","notification_client_id":"string","notification_client_token":"string","request_timeout":42,"notification_value_path":"string","include_write_permission":true,"deleted":true}}'

Request examples

{
  "data": {
    "reference_class_name": "string",
    "reference_ids": "string",
    "database_action": "string",
    "notification_type": "string",
    "notification_url": "string",
    "notification_client_id": "string",
    "notification_client_token": "string",
    "request_timeout": 42,
    "notification_value_path": "string",
    "include_write_permission": true,
    "deleted": true
  }
}

Response examples (200)

{
  "reference_class_name": "string",
  "reference_ids": "string",
  "database_action": "string",
  "notification_type": "string",
  "notification_url": "string",
  "request_timeout": 42,
  "notification_value_path": "string",
  "include_write_permission": true,
  "created": "2025-05-04T09:42:00Z",
  "updated": "2025-05-04T09:42:00Z",
  "name": "string",
  "deleted": true
}