Webhook-Endpunkte

Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "WebHook".

Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.

Hinweise zur Funktion

Derzeit bieten wir die Möglichkeit, die Daten eines bereits angelegten Webhooks zu ändern. Sollte sich die Notwendigkeit einer Passwort- oder URL-Änderung bei den Schnittstellenanwendern ergeben, muss nicht auf die Kundenreaktion gewartet werden.

Die Entscheidung der Neuanlage eines Webhooks liegt allerdings weiterhin beim Kunden.

Für die Anwendung der Endpunkte muss der Webhook Ihrem API-Key zugewiesen sein.

Webhooks abrufen

Version 1.2

---

GET/openwowi/v1.2/WebHook/WebHook

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

Namenullable string

SystemPurposenullable string

Urlnullable string

Activeboolean

Sourcenullable all of

AuthTypenullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/WebHook/WebHook', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "Id": 0,
    "Name": "text",
    "SystemPurpose": "text",
    "Url": "text",
    "Active": false,
    "Source": {
      "Id": 0,
      "Code": "text",
      "EntityName": "text"
    },
    "AuthType": {
      "Id": 0,
      "Code": "text"
    }
  }
]

---

Webhooks ändern

Version 1.2

---

PUT/openwowi/v1.2/WebHook/WebHook/Change

Authorization

Authorization

Query parameters

Body

application/jsontext/jsonapplication/*+json

Idinteger (int32)

Urlnullable string

Activeboolean

AuthenticationTypeIdinteger (int32)

AuthBearernullable all of

AuthBasicnullable all of

AuthCustomnullable all of

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

Namenullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/WebHook/WebHook/Change', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "Id": 0,
  "Name": "text"
}

---

Webhooks testen

Version 1.2

---

POST/openwowi/v1.2/WebHook/WebHook/TestExecute

Authorization

Authorization

Query parameters

Body

application/jsontext/jsonapplication/*+json

Idinteger (int32)

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

Namenullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/WebHook/WebHook/TestExecute', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "Id": 0,
  "Name": "text"
}

---