Knuddels User Apps - API Dokumentation

  • Dokumentation für Version 20260217-132220 (ChatServer: 20260217-132220)

    • Knuddels
    User App Entwicklung
    API Dokumentation
    WebHookAccess

    WebHookAccess Klasse

    Modul: WebHooks

    Verfügbar ab Version AppServer 20260213-125115

    Beta Diese Klasse ist noch nicht offiziell freigegeben und kann sich jederzeit ändern.

    Ermöglicht das Registrieren und Verwalten von WebHooks für eine App.

    Über WebHooks kann eine App HTTP-Requests von externen Diensten empfangen und verarbeiten. Jede App erhält ein persistentes, zufällig generiertes Prefix, das in der URL enthalten ist. Die resultierende WebHook-URL hat das Format {baseUrl}/{webhookPrefix}/{key}.

    Die Instanz von WebHookAccess erhält man über den KnuddelsServer mit KnuddelsServer.getWebHookAccess()

    Methoden

    getRegisteredWebhooks

    () String[] Beta

    Liefert die Keys aller aktuell registrierten WebHooks dieser App.

    Rückgabewert:

    String[]:

    Die Keys der registrierten WebHooks.

    Beispiel:

    var keys = KnuddelsServer.getWebHookAccess().getRegisteredWebhooks();
KnuddelsServer.getDefaultLogger().info('Registrierte WebHooks: ' + keys);

    getWebHookUrl

    (
    • key
    )
    String | Null Beta

    Liefert die vollständige WebHook-URL für den angegebenen Key oder null, wenn kein WebHook mit diesem Key registriert ist.

    Parameter:

    • key String

      Der Key des WebHooks.

    Rückgabewert:

    String | Null:

    Die WebHook-URL oder null.

    Beispiel:

    var url = KnuddelsServer.getWebHookAccess().getWebHookUrl('payments');
KnuddelsServer.getDefaultLogger().info('WebHook URL: ' + url);

    registerWebHook

    (
    • key
    • observer
    )
    String Beta

    Registriert einen neuen WebHook mit dem angegebenen Key und einer Observer-Callback-Funktion.

    Der key muss zwischen 1 und 50 Zeichen lang sein und darf nur alphanumerische Zeichen, Unterstriche (_) und Bindestriche (-) enthalten.

    Wird ein bereits registrierter Key erneut registriert, so wird der vorherige WebHook überschrieben.

    Der observer wird bei jedem eingehenden HTTP-Request aufgerufen und erhält zwei Parameter: request und response. Mit response.send(statusCode, headers, body) kann die HTTP-Antwort gesendet werden.

    Parameter:

    • key String

      Der eindeutige Key für diesen WebHook (pro App).

    • observer Function

      Die Callback-Funktion, die bei eingehenden Requests aufgerufen wird.

    Rückgabewert:

    String:

    Die vollständige WebHook-URL, unter der der WebHook erreichbar ist.

    Beispiel:

    var webHookAccess = KnuddelsServer.getWebHookAccess();
var url = webHookAccess.registerWebHook('payments', function(request, response) {
    var body = JSON.parse(request.getBody());
    response.send(200, {'Content-Type': 'application/json'}, '{"status":"ok"}');
});
KnuddelsServer.getDefaultLogger().info('WebHook URL: ' + url);

    unregisterAllWebHooks

    () Beta

    Deregistriert alle WebHooks dieser App.

    Beispiel:

    KnuddelsServer.getWebHookAccess().unregisterAllWebHooks();

    unregisterWebHook

    (
    • key
    )
    Beta

    Deregistriert einen zuvor registrierten WebHook anhand seines Keys.

    Hat die App keinen WebHook mit dem angegebenen Key registriert, passiert nichts.

    Parameter:

    • key String

      Der Key des zu deregistrierenden WebHooks.

    Beispiel:

    KnuddelsServer.getWebHookAccess().unregisterWebHook('payments');