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
Authorizations
Query parameters
apiKeystringOptional
limitinteger · int32OptionalExample: 20
offsetinteger · int32Optional
webHookIdinteger · int32Optional
showNullValuesbooleanOptionalDefault: false
Responses
200
OK
get
GET /openwowi/v1.2/WebHook/WebHook HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Webhooks ändern

Version 1.2

put
Authorizations
Query parameters
apiKeystringOptional
Body
Idinteger · int32Optional
Urlstring | nullableOptional
ActivebooleanOptional
AuthenticationTypeIdinteger · int32Optional
Responses
200
OK
put
PUT /openwowi/v1.2/WebHook/WebHook/Change HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "Id": 1,
  "Url": "text",
  "Active": true,
  "AuthenticationTypeId": 1,
  "AuthBearer": {
    "BearerToken": "text"
  },
  "AuthBasic": {
    "User": "text",
    "Password": "text"
  },
  "AuthCustom": {
    "HeaderName": "text",
    "HeaderValue": "text"
  }
}
{
  "Id": 1,
  "Name": "text"
}

Webhooks testen

Version 1.2

post
Authorizations
Query parameters
apiKeystringOptional
Body
Idinteger · int32Optional
Responses
200
OK
post
POST /openwowi/v1.2/WebHook/WebHook/TestExecute HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

{
  "Id": 1
}
{
  "Id": 1,
  "Name": "text"
}
PreviousBeispiel WorkflowNextKataloge

Last updated