Skip to content

Commit d0763db

Browse files
authored
Merge pull request #46 from buggregator/issue/35
Fixes the directory for webhook configurations
2 parents c8ab85d + 8ae5bfb commit d0763db

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

docs/config/webhooks.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ configuration files within a Docker container.
2727

2828
```bash
2929
docker run --pull always \
30-
-v /path/to/webhooks:/app/runtime/webhooks \
30+
-v /path/to/webhooks:/app/runtime/configs \
3131
ghcr.io/buggregator/server:latest
3232
```
3333

@@ -37,15 +37,15 @@ or using `docker-compose`:
3737
buggregator-server:
3838
...
3939
volumes:
40-
- /path/to/webhooks:/app/runtime/webhooks
40+
- /path/to/webhooks:/app/runtime/configs
4141
```
4242
4343
## Configuring a Webhook
4444
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
4646
contain one webhook setup.
4747

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`:
4949

5050
```yaml
5151
webhook:
@@ -58,6 +58,8 @@ webhook:
5858
retry_on_failure: true
5959
```
6060

61+
> **Note:** The webhook configuration file name should have the following pattern: `<name>.webhook.yaml` or `<name>.webhook.yml`.
62+
6163
**Key Components of a Webhook Configuration:**
6264

6365
- **Event:** The specific event in Buggregator that will trigger the webhook.
@@ -73,11 +75,11 @@ webhook:
7375

7476
Buggregator can currently handle the following events:
7577

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`

0 commit comments

Comments
 (0)