airflow.providers.apprise.notifications.apprise

Module Contents

Classes

AppriseNotifier

Apprise BaseNotifier.

Attributes

send_apprise_notification

class airflow.providers.apprise.notifications.apprise.AppriseNotifier(*, body, title=None, notify_type=None, body_format=None, tag=None, attach=None, interpret_escapes=None, config=None, apprise_conn_id=AppriseHook.default_conn_name)[source]

Bases: airflow.notifications.basenotifier.BaseNotifier

Apprise BaseNotifier.

Parameters

  • body (str) – Specify the message body

  • title (str | None) – Specify the message title. This field is complete optional

  • notify_type (apprise.NotifyType | None) – Specify the message type (default=info). Possible values are “info”, “success”, “failure”, and “warning”

  • body_format (apprise.NotifyFormat | None) – Specify the input message format (default=text). Possible values are “text”, “html”, and “markdown”.

  • tag (str | Iterable[str] | None) – Specify one or more tags to filter which services to notify

  • attach (str | None) – Specify one or more file attachment locations

  • interpret_escapes (bool | None) – Enable interpretation of backslash escapes. For example, this would convert sequences such as n and r to their respected ascii new-line and carriage

  • config (apprise.AppriseConfig | None) – Specify one or more configuration

  • apprise_conn_id (str) – connection that has Apprise configs setup

template_fields = ('body', 'title', 'tag', 'attach')[source]
hook()[source]

Apprise Hook.

notify(context)[source]

Send a alert to a apprise configured service.

airflow.providers.apprise.notifications.apprise.send_apprise_notification[source]

Was this entry helpful?