nodes/generated

Interface Signl4NodeParameters

Source
interface Signl4NodeParameters {
    additionalFields?: {
        alertingScenario?: "single_ack" | "multi_ack";
        attachmentsUi?: {
            attachmentsBinary: { property?: string };
        };
        externalId?: string;
        filtering?: boolean;
        locationFieldsUi?: {
            locationFieldsValues: {
                latitude: string;
                longitude: string;
            };
        };
        service?: string;
        title?: string;
    };
    externalId?: string;
    message?: string;
    operation?: "send"
    | "resolve";
    resource?: "alert";
}

Properties§

§readonly additionalFields?: { ... }

Default: {}

§readonly externalId?: string

If the event originates from a record in a 3rd party system, use this parameter to pass the unique ID of that record. That ID will be communicated in outbound webhook notifications from SIGNL4, which is great for correlation/synchronization of that record with the alert. If you resolve / close an alert you must use the same External ID as in the original alert.

§readonly message?: string

A more detailed description for the alert

§readonly operation?: "send" | "resolve"

Default: "send"

§readonly resource?: "alert"

Default: "alert"