airflow.providers.discord.notifications.discord¶

Attributes¶

ICON_URL

Classes¶

DiscordNotifier

Discord BaseNotifier.

Module Contents¶

airflow.providers.discord.notifications.discord.ICON_URL: str = 'https://raw.githubusercontent.com/apache/airflow/main/airflow-core/src/airflow/ui/public/pin_100.png'[source]¶

class airflow.providers.discord.notifications.discord.DiscordNotifier(discord_conn_id='discord_webhook_default', text='', username='Airflow', avatar_url=ICON_URL, tts=False, embed=None, **kwargs)[source]¶

Bases: airflow.providers.common.compat.notifier.BaseNotifier

Discord BaseNotifier.

Parameters:

discord_conn_id (str) – Http connection ID with host as “https://discord.com/api/” and default webhook endpoint in the extra field in the form of {“webhook_endpoint”: “webhooks/{webhook.id}/{webhook.token}”}
text (str) – The content of the message
username (str) – The username to send the message as. Optional
avatar_url (str) – The URL of the avatar to use for the message. Optional
tts (bool) – Text to speech.
embed (airflow.providers.discord.notifications.embed.Embed | None) – Discord embed object. See: https://discord.com/developers/docs/resources/message#embed-object-embed-author-structure

template_fields = ('discord_conn_id', 'text', 'username', 'avatar_url', 'tts', 'embed')[source]¶

discord_conn_id = 'discord_webhook_default'[source]¶

text = ''[source]¶

username = 'Airflow'[source]¶

avatar_url = 'https://raw.githubusercontent.com/apache/airflow/main/airflow-core/src/airflow/ui/public/pin_100.png'[source]¶

tts = False[source]¶

embed = None[source]¶

property hook: airflow.providers.discord.hooks.discord_webhook.DiscordWebhookHook[source]¶

Discord Webhook Hook.

property hook_async: airflow.providers.discord.hooks.discord_webhook.DiscordWebhookAsyncHook[source]¶

Discord Webhook Async Hook.

notify(context)[source]¶

Send a message to a Discord channel.

Parameters:: context – the context object
Returns:: None

async async_notify(context)[source]¶

Send a message to a Discord channel using async HTTP.

Parameters:: context – the context object
Returns:: None
Return type:: None