Webhook

`services.webhook.enable`

Whether to enable Webhook, a server written in Go that allows you to create HTTP endpoints (hooks), which execute configured commands for any person or service that knows the URL . Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/webhook.nix

`services.webhook.enableTemplates`

Enable the generated hooks file to be parsed as a Go template. See the documentation for more information.

Type: boolean

Default

hooksTemplated != {}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/webhook.nix

`services.webhook.environment`

Extra environment variables passed to webhook. Type: attribute set of string

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/webhook.nix

`services.webhook.extraArgs`

These are arguments passed to the webhook command in the systemd service. You can find the available arguments and options in the documentation.

Type: list of string

Default

[ ]

Example

["-secure"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/webhook.nix

`services.webhook.group`

Webhook will be run under this group.

If set, you must create this group yourself!

Type: string

Default

"webhook"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/webhook.nix

`services.webhook.hooks`

The actual configuration of which hooks will be served.

Read more on the project homepage and on the hook definition page. At least one hook needs to be configured.

Type: attribute set of (JSON value)

Default

{ }

Example

{echo = {execute-command = "echo";response-message = "Webhook is reachable!";};redeploy-webhook = {command-working-directory = "/var/webhook";execute-command = "/var/scripts/redeploy.sh";};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/webhook.nix

`services.webhook.hooks.<name>.execute-command`

The command that should be executed when the hook is triggered. Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/webhook.nix

`services.webhook.hooks.<name>.id`

The ID of your hook. This value is used to create the HTTP endpoint (protocol://yourserver:port/prefix/${id}).

Type: string

Default

"‹name›"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/webhook.nix

`services.webhook.hooksTemplated`

Same as {option}hooks, but these hooks are specified as literal strings instead of Nix values, and hence can include template syntax which might not be representable as JSON.

Template syntax requires the {option}enableTemplates option to be set to true, which is done by default if this option is set.

Type: attribute set of string