Webhook Notification Settings

This page documents settings for configuring an Webhook service as a target for Bucket Notifications. See Publish Events to 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 AIStor Server. Refer to your operating system’s documentation for how to define an environment variable.
a configuration setting using mc admin config set.

If you define both an environment variable and the similar configuration setting, AIStor uses the environment variable value.

Some settings have only an environment variable or a configuration setting, but not both.

Each configuration setting controls fundamental AIStor behavior and functionality. Test configuration changes in a lower environment, such as DEV or QA, before applying to production.

Example

Environment Variables

You can specify multiple targets by appending a unique identifier _ID for each set of related settings.

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"

Configuration Settings

You can specify multiple targets by appending a unique identifier :ID to the configuration key.

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

Enable

Environment Variable Configuration Setting

Specify on to enable publishing bucket notifications to a Webhook service endpoint. Defaults to off.

Endpoint

Environment Variable Configuration Setting

Specify the URL for the webhook service.

AIStor checks the health of the specified URL (if it is resolvable and reachable) prior to adding the target. AIStor adds offline targets without blocking.

Auth token

Environment Variable Configuration Setting

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, AIStor 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:

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:

export MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_xyz="ServiceXYZ 1a2b3c4f5e"

Consult the documentation for the desired service for more details.

AIStor redacts this value when returned as part of mc admin config get.

Queue dir

Environment Variable Configuration Setting

Specify the directory path to enable MinIO’s persistent event store for undelivered messages, such as /opt/minio/events.

AIStor stores undelivered events in the specified store while the webhook service is offline and replays the stored events when connectivity resumes.

Queue limit

Environment Variable Configuration Setting

Specify the maximum limit for undelivered messages. Defaults to 100000.

Client cert

Environment Variable Configuration Setting

Specify the path to the client certificate to use for performing mTLS authentication to the webhook service.

Client key

Environment Variable Configuration Setting

Specify the path to the client private key to use for performing mTLS authentication to the webhook service.

Max retry

Environment Variable Configuration Setting

Maximum number of attempts to retry an event send. By default, the max number of retries is set to 0.

Retry interval

Environment Variable Configuration Setting

Length of time to wait between retry attempts. The default value is 3s.

Comment

Environment Variable Configuration Setting

Specify a comment to associate with the Webhook configuration.