File tree Expand file tree Collapse file tree 1 file changed +14
-12
lines changed Expand file tree Collapse file tree 1 file changed +14
-12
lines changed Original file line number Diff line number Diff line change @@ -27,7 +27,7 @@ configuration files within a Docker container.
27
27
28
28
``` bash
29
29
docker run --pull always \
30
- -v /path/to/webhooks:/app/runtime/webhooks \
30
+ -v /path/to/webhooks:/app/runtime/configs \
31
31
ghcr.io/buggregator/server:latest
32
32
```
33
33
@@ -37,15 +37,15 @@ or using `docker-compose`:
37
37
buggregator-server :
38
38
...
39
39
volumes :
40
- - /path/to/webhooks:/app/runtime/webhooks
40
+ - /path/to/webhooks:/app/runtime/configs
41
41
` ` `
42
42
43
43
## Configuring a Webhook
44
44
45
- Place each webhook configuration in a YAML file within the ` runtime/webhooks ` directory. Each configuration file should
45
+ Place each webhook configuration in a YAML file within the ` runtime/configs ` directory. Each configuration file should
46
46
contain one webhook setup.
47
47
48
- Here’s what a typical webhook configuration looks like :
48
+ Here’s what a typical webhook configuration looks like in a YAML file `sentry.webhook.yaml` :
49
49
50
50
` ` ` yaml
51
51
webhook:
@@ -58,6 +58,8 @@ webhook:
58
58
retry_on_failure: true
59
59
` ` `
60
60
61
+ > **Note:** The webhook configuration file name should have the following pattern: `<name>.webhook.yaml` or `<name>.webhook.yml`.
62
+
61
63
**Key Components of a Webhook Configuration:**
62
64
63
65
- **Event:** The specific event in Buggregator that will trigger the webhook.
@@ -73,11 +75,11 @@ webhook:
73
75
74
76
Buggregator can currently handle the following events :
75
77
76
- - sentry.received
77
- - monolog.received
78
- - var-dumper.received
79
- - ray.received
80
- - inspector.received
81
- - http-dump.received
82
- - profiler.received
83
- - smtp.received
78
+ - ` sentry.received`
79
+ - ` monolog.received`
80
+ - ` var-dumper.received`
81
+ - ` ray.received`
82
+ - ` inspector.received`
83
+ - ` http-dump.received`
84
+ - ` profiler.received`
85
+ - ` smtp.received`
You can’t perform that action at this time.
0 commit comments