> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# credentials

# `prefect_slack.credentials`

Credential classes use to store Slack credentials.

## Classes

### `SlackCredentials` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect\_slack/credentials.py#L15](https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect_slack/credentials.py#L15)</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 theme={null}
from prefect_slack import SlackCredentials
slack_credentials_block = SlackCredentials.load("BLOCK_NAME")
```

Get a Slack client:

```python theme={null}
from prefect_slack import SlackCredentials
slack_credentials_block = SlackCredentials.load("BLOCK_NAME")
client = slack_credentials_block.get_client()
```

**Methods:**

#### `get_client` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect\_slack/credentials.py#L46](https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect_slack/credentials.py#L46)</sup>

```python theme={null}
get_client(self) -> AsyncWebClient
```

Returns an authenticated `AsyncWebClient` to interact with the Slack API.

### `SlackWebhook` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect\_slack/credentials.py#L53](https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect_slack/credentials.py#L53)</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 theme={null}
from prefect_slack import SlackWebhook
slack_webhook_block = SlackWebhook.load("BLOCK_NAME")
```

Get a Slack webhook client:

```python theme={null}
from prefect_slack import SlackWebhook
slack_webhook_block = SlackWebhook.load("BLOCK_NAME")
client = slack_webhook_block.get_client()
```

Send a notification in Slack:

```python theme={null}
from prefect_slack import SlackWebhook
slack_webhook_block = SlackWebhook.load("BLOCK_NAME")
slack_webhook_block.notify("Hello, world!")
```

**Methods:**

#### `get_client` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect\_slack/credentials.py#L94](https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect_slack/credentials.py#L94)</sup>

```python theme={null}
get_client(self, sync_client: bool = False) -> Union[AsyncWebhookClient, WebhookClient]
```

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

#### `notify` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect\_slack/credentials.py#L131](https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect_slack/credentials.py#L131)</sup>

```python theme={null}
notify(self, body: str, subject: Optional[str] = None)
```

Sends a message to the Slack channel.

#### `notify_async` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect\_slack/credentials.py#L122](https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-slack/prefect_slack/credentials.py#L122)</sup>

```python theme={null}
notify_async(self, body: str, subject: Optional[str] = None)
```

Sends a message to the Slack channel asynchronously.