Returns a list of webhooks

GET /api/dw/webhook

Query parameters

  • deleted boolean

    This property is used to mark an entity as deleted / archived | Requires access right: SCOPE | Default value: false

  • referenceClassName string

    Requires access right: SCOPE

  • referenceIds string

    Requires access right: SCOPE

  • databaseAction string

    Requires access right: SCOPE

  • notificationType string

    Requires access right: SCOPE

  • notificationUrl string

    Requires access right: SCOPE

  • requestTimeout string

    Requires access right: SCOPE

  • includeWritePermission boolean

    Requires access right: SCOPE

  • searchString string

    text to search for in the list

  • orderFieldName string

    name of the order field

  • orderFieldSort string

    sorting mode

    Values are DESC or ASC.

  • page integer

    page of the list

    Default value is 0.

  • pageSize integer

    number of entries for each page

    Minimum value is 1, maximum value is 200. Default value is 50.

  • withMaxPageNumber string

    returns the number of pages available as a header if this is set

  • iw-build-id string

    build id of the client

  • iw-package-id string

    package id of the client

Responses

  • 200 application/json

    Returns a list of webhooks

    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
GET /api/dw/webhook
curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/dw/webhook' \
 --header "x-session-token: $API_KEY"
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
  }
]