# Webhook Service Notification Settings
LLMS index: [llms.txt](/llms.txt)
---
This page documents settings for configuring an Webhook service as a target for [Bucket Notifications](/administration/monitoring/bucket-notifications/#minio-bucket-notifications). See [Publish Events to Webhook](/administration/monitoring/publish-events-to-webhook/#minio-bucket-notifications-publish-webhook) for a tutorial on using these settings.
You can establish or modify settings by defining:
- an *environment variable* on the host system prior to starting or restarting the MinIO Server. Refer to your operating system’s documentation for how to define an environment variable.
- a *configuration setting* using [`mc admin config set`](/reference/minio-mc-admin/mc-admin-config/#mc.admin.config.set).
If you define both an environment variable and the similar configuration setting, MinIO uses the environment variable value.
Some settings have only an environment variable or a configuration setting, but not both.
> [!WARNING]
> **Important**
>
> Each configuration setting controls fundamental MinIO behavior and functionality. MinIO **strongly recommends** testing configuration changes in a lower environment, such as DEV or QA, before applying to production.
## Multiple Webhook Service Targets {#multiple-webhook-service-targets}
You can specify multiple Webhook service endpoints by appending a unique identifier `_ID` for each set of related Webhook settings on to the top level key. For example, the following commands set two distinct Webhook service endpoints as `PRIMARY` and `SECONDARY` respectively:
```shell {tab="Environment Variables" group="environment-variables-configuration-settings" value="environment-variables"}
export MINIO_NOTIFY_WEBHOOK_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_WEBHOOK_ENDPOINT_PRIMARY="https://webhook1.example.net"
export MINIO_NOTIFY_WEBHOOK_ENABLE_SECONDARY="on"
export MINIO_NOTIFY_WEBHOOK_ENDPOINT_SECONDARY="https://webhook1.example.net"
```
```shell {tab="Configuration Settings" value="configuration-settings"}
mc admin config set notify_webhook:primary \
endpoint="https://webhook1.example.net"
[ARGUMENT=VALUE ...]
mc admin config set notify_webhook:secondary \
endpoint="https://webhook2.example.net
[ARGUMENT=VALUE ...]
```
## Settings {#settings}
### Enable {#enable}
*Required*
**Environment Variable**
##### `MINIO_NOTIFY_WEBHOOK_ENABLE` {#envvar.MINIO_NOTIFY_WEBHOOK_ENABLE}
*envvar*
Specify `on` to enable publishing bucket notifications to a Webhook service endpoint.
Defaults to `off`.
**Configuration Setting**
##### `notify_webhook` {#mc-conf.notify_webhook}
*mc-conf*
The top-level configuration key for defining an Webhook service endpoint for use with [MinIO bucket notifications](/administration/monitoring/bucket-notifications/#minio-bucket-notifications).
Use [`mc admin config set`](/reference/minio-mc-admin/mc-admin-config/#mc.admin.config.set) to set or update an Webhook service endpoint. The [`endpoint`](#mc-conf.notify_webhook.endpoint) argument is *required* for each target. Specify additional optional arguments as a whitespace (`" "`)-delimited list.
```shell
mc admin config set notify_webhook \
endpoint="https://webhook.example.net"
[ARGUMENT="VALUE"] ... \
```
### Endpoint {#endpoint}
*Required*
**Environment Variable**
##### `MINIO_NOTIFY_WEBHOOK_ENDPOINT` {#envvar.MINIO_NOTIFY_WEBHOOK_ENDPOINT}
*envvar*
**Configuration Setting**
##### `notify_webhook endpoint` {#mc-conf.notify_webhook.endpoint}
*mc-conf*
Specify the URL for the webhook service.
> [!NOTE]
> **Changed: RELEASE.2023-05-27T05-56-19Z**
>
> MinIO checks the health of the specified URL (if it is resolvable and reachable) prior to adding the target. MinIO no longer blocks adding new notification targets if existing targets are offline.
### Auth Token {#auth-token}
*Required*
**Environment Variable**
##### `MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN` {#envvar.MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN}
*envvar*
An authentication token of the appropriate type for the endpoint. Omit for endpoints which do not require authentication.
To allow for a variety of token types, MinIO creates the request authentication header using the value *exactly as specified*. Depending on the endpoint, you may need to include additional information.
For example, for a Bearer token, prepend `Bearer`:
```shell
export MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_myendpoint="Bearer 1a2b3c4f5e"
```
Modify the value according to the endpoint requirements. A custom authentication format could resemble the following:
```shell
export MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_xyz="ServiceXYZ 1a2b3c4f5e"
```
Consult the documentation for the desired service for more details.
**Configuration Setting**
##### `notify_webhook auth_token` {#mc-conf.notify_webhook.auth_token}
*mc-conf*
An authentication token of the appropriate type for the endpoint. Omit for endpoints which do not require authentication.
To allow for a variety of token types, MinIO creates the request authentication header using the value *exactly as specified*. Depending on the endpoint, you may need to include additional information.
For example, for a Bearer token, prepend `Bearer`:
```shell
mc admin config set myminio notify_webhook \
endpoint="https://webhook-1.example.net" \
auth_token="Bearer 1a2b3c4f5e"
```
Modify the value according to the endpoint requirements. A custom authentication format could resemble the following:
```shell
mc admin config set myminio notify_webhook \
endpoint="https://webhook-1.example.net" \
auth_token="ServiceXYZ 1a2b3c4f5e"
```
Consult the documentation for the desired service for more details.
> [!NOTE]
> **Changed: RELEASE.2023-06-23T20-26-00Z**
MinIO redacts this value when returned as part of [`mc admin config get`](/reference/minio-mc-admin/mc-admin-config/#mc.admin.config.get).
### Queue Directory {#queue-directory}
*Optional*
**Environment Variable**
##### `MINIO_NOTIFY_WEBHOOK_QUEUE_DIR` {#envvar.MINIO_NOTIFY_WEBHOOK_QUEUE_DIR}
*envvar*
**Configuration Setting**
##### `notify_webhook queue_dir` {#mc-conf.notify_webhook.queue_dir}
*mc-conf*
Specify the directory path to enable MinIO’s persistent event store for undelivered messages, such as `/opt/minio/events`.
MinIO stores undelivered events in the specified store while the webhook service is offline and replays the stored events when connectivity resumes.
### Queue Limit {#queue-limit}
*Optional*
**Environment Variable**
##### `MINIO_NOTIFY_WEBHOOK_QUEUE_LIMIT` {#envvar.MINIO_NOTIFY_WEBHOOK_QUEUE_LIMIT}
*envvar*
**Configuration Setting**
##### `notify_webhook queue_limit` {#mc-conf.notify_webhook.queue_limit}
*mc-conf*
Specify the maximum limit for undelivered messages. Defaults to `100000`.
### Client Certificate {#client-certificate}
*Optional*
**Environment Variable**
##### `MINIO_NOTIFY_WEBHOOK_CLIENT_CERT` {#envvar.MINIO_NOTIFY_WEBHOOK_CLIENT_CERT}
*envvar*
**Configuration Setting**
##### `notify_webhook client_cert` {#mc-conf.notify_webhook.client_cert}
*mc-conf*
Specify the path to the client certificate to use for performing mTLS authentication to the webhook service.
### Client Key {#client-key}
*Optional*
**Environment Variable**
##### `MINIO_NOTIFY_WEBHOOK_CLIENT_KEY` {#envvar.MINIO_NOTIFY_WEBHOOK_CLIENT_KEY}
*envvar*
**Configuration Setting**
##### `notify_webhook client_key` {#mc-conf.notify_webhook.client_key}
*mc-conf*
Specify the path to the client private key to use for performing mTLS authentication to the webhook service.