CreatePlatformNotificationRequest: {
    call_to_action: string;
    content: { [key: string]: NotificationContentRequest };
    context:
        | "ACCOUNT"
        | "STUDIO"
        | "WORKSPACE"
        | "AI"
        | "Account"
        | "Studio"
        | "Workspace";
    criticality: "LOW"
    | "MEDIUM"
    | "HIGH"
    | "LOW"
    | "MEDIUM"
    | "HIGH";
    last_until?: string;
    persistent: boolean;
    trigger_at: string;
}

Type declaration

  • call_to_action: string

    Possible redirect link for the notification button.

  • content: { [key: string]: NotificationContentRequest }

    Map of language codes to notification content. Each entry represents the content of the notification in a specific language.

  • context: "ACCOUNT" | "STUDIO" | "WORKSPACE" | "AI" | "Account" | "Studio" | "Workspace"

    Which context to publish the notification

  • criticality: "LOW" | "MEDIUM" | "HIGH" | "LOW" | "MEDIUM" | "HIGH"

    Criticality of the notification.

  • Optionallast_until?: string

    UTC formatted timestamp to when the notification should finally ended if the persistent is set to true.

  • persistent: boolean

    If the notification should be re-consumed until last_until is reached.

  • trigger_at: string

    UTC formatted timestamp for when to triggers the notification.