ContextQMD
Back to Prefect

credentials

docs/integrations/prefect-slack/api-ref/prefect_slack-credentials.mdx

3.6.30.dev33.2 KB
Original Source

prefect_slack.credentials

Credential classes use to store Slack credentials.

Classes

SlackCredentials <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect_slack/credentials.py#L15" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

Block holding Slack credentials for use in tasks and flows.

Args:

  • token: Bot user OAuth token for the Slack app used to perform actions.

Examples:

Load stored Slack credentials:

python
from prefect_slack import SlackCredentials
slack_credentials_block = SlackCredentials.load("BLOCK_NAME")

Get a Slack client:

python
from prefect_slack import SlackCredentials
slack_credentials_block = SlackCredentials.load("BLOCK_NAME")
client = slack_credentials_block.get_client()

Methods:

get_client <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect_slack/credentials.py#L46" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
get_client(self) -> AsyncWebClient

Returns an authenticated AsyncWebClient to interact with the Slack API.

SlackWebhook <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect_slack/credentials.py#L53" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

Block holding a Slack webhook for use in tasks and flows.

Args:

  • url: Slack webhook URL which can be used to send messages (e.g. https\://hooks.slack.com/XXX).

Examples:

Load stored Slack webhook:

python
from prefect_slack import SlackWebhook
slack_webhook_block = SlackWebhook.load("BLOCK_NAME")

Get a Slack webhook client:

python
from prefect_slack import SlackWebhook
slack_webhook_block = SlackWebhook.load("BLOCK_NAME")
client = slack_webhook_block.get_client()

Send a notification in Slack:

python
from prefect_slack import SlackWebhook
slack_webhook_block = SlackWebhook.load("BLOCK_NAME")
slack_webhook_block.notify("Hello, world!")

Methods:

get_client <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect_slack/credentials.py#L94" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
get_client(self, sync_client: bool = False) -> Union[AsyncWebhookClient, WebhookClient]

Returns an authenticated AsyncWebhookClient to interact with the configured Slack webhook.

notify <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect_slack/credentials.py#L127" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
notify(self, body: str, subject: Optional[str] = None)

Sends a message to the Slack channel.

notify_async <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect_slack/credentials.py#L118" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
notify_async(self, body: str, subject: Optional[str] = None)

Sends a message to the Slack channel asynchronously.