docs-archive/apache-airflow-providers-discord/3.0.0/_sources/_api/airflow/providers/discord/operators/discord_webhook/index.rst.txt

:py:mod:`airflow.providers.discord.operators.discord_webhook`
=============================================================

.. py:module:: airflow.providers.discord.operators.discord_webhook


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   airflow.providers.discord.operators.discord_webhook.DiscordWebhookOperator




.. py:class:: DiscordWebhookOperator(*, http_conn_id = None, webhook_endpoint = None, message = '', username = None, avatar_url = None, tts = False, proxy = None, **kwargs)

   Bases: :py:obj:`airflow.providers.http.operators.http.SimpleHttpOperator`

   This operator allows you to post messages to Discord using incoming webhooks.
   Takes a Discord connection ID with a default relative webhook endpoint. The
   default endpoint can be overridden using the webhook_endpoint parameter
   (https://discordapp.com/developers/docs/resources/webhook).

   Each Discord webhook can be pre-configured to use a specific username and
   avatar_url. You can override these defaults in this operator.

   :param http_conn_id: 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}"}
   :param webhook_endpoint: Discord webhook endpoint in the form of
                            "webhooks/{webhook.id}/{webhook.token}" (templated)
   :param message: The message you want to send to your Discord channel
                   (max 2000 characters). (templated)
   :param username: Override the default username of the webhook. (templated)
   :param avatar_url: Override the default avatar of the webhook
   :param tts: Is a text-to-speech message
   :param proxy: Proxy to use to make the Discord webhook call

   .. py:attribute:: template_fields
      :annotation: :Sequence[str] = ['username', 'message', 'webhook_endpoint']

      

   .. py:method:: execute(self, context)

      Call the DiscordWebhookHook to post message