callWebhook

function callWebhook(options: CallWebhookOptions): HttpClientResponse;

Die Funktion callWebhook führt einen Webhook-Aufruf mit den angegebenen Mappendaten aus.

Der Parameter der Funktion ist vom Typ CallWebhookOptions. Zurückgegeben wird ein Objekt vom Typ HttpClientResponse.

Beispiele

Aufruf ohne Payload Builder:

const { callWebhook } = require("ou.sp.Webhook");
const options = {
    url: "https://test.com/webhook",
    method: "POST",
    file: context.file,
    fileFields: ["field1", "field2"],
    attachments: [
        {
            registerName: "testRegister",
            matchFullName: true,
            fileNameFilter: "test.pdf",
        }
    ],
};
const response = callWebhook(options);
if (response.status !== 200) {
    throw new Error(`Webhook call failed with '${response.data}', exitCode was: ${response.status}`);
}

info

Wird kein Payload Builder übergeben, so wird der Standard Payload Builder verwendet, welcher einen Payload aus den angegebenen Mappenfeldern und den in den angegebenen Registern gefundenen Dokumenten (unter Berücksichtigung des Dateinamen-Filters - sofern vorhanden) generiert.

Aufruf mit eigenem Payload Builder:

const { callWebhook } = require("ou.sp.Webhook");
const options = {
    url: "https://test.com/webhook",
    method: "POST",
    file: context.file,
    fileFields: ["field1", "field2", "field3"],
    attachments: [
        {
            registerName: "testRegister",
            fileNameFilter: ".pdf",
        }
    ],
    payloadBuilder: (fileFields, attachments) => {
        return {
            additionalInformation: "blub",
            fileFields,
            file: Object.values(attachments).map((filePath) => `@${filePath};type=application/pdf`),
        };
    },
};
const response = callWebhook(options);
if (response.status !== 200) {
    throw new Error(`Webhook call failed with '${response.data}', exitCode was: ${response.status}`);
}