Skip to main content

Notifications

Some generative tools may require several minutes to complete processing, which can negatively impact the user experience. To improve usability, this feature allows users to close the tool and receive a notification once the generation is complete.

Enabling Notifications​

To enable notifications for your task, make sure notifications are enabled for the task in your worker's configuration. Refer to Task Registration page for details on how to configure this.

Notifications options​

An optional notification object can be passed when submitting a task via the Async API:

"notification": {
    "projectId": "...",
    "miniappPackageId": "...",
    "actions": [{
        "deeplink": "...",
        "mobileDeeplink": "..."
    }]
}
  • projectId - the ID of the project from which the task was triggered
  • miniappPackageId - the ID of the miniapp from which the task was triggered
  • actions - call-to-action (CTA) deeplinks
note

The deeplink(s) specified in the actions will be updated by the backend to include the task_id as a query parameter, enabling the miniapp to correctly restore its state.