Skip to content

Commit c476965

Browse files
authored
Merge pull request #1077 from v1km4n/docs1063
Update docs to include Telegram forum configuration
2 parents e2eac40 + 1a9858d commit c476965

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

docs/spec/v1beta1/providers.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,8 @@ and use `https://api.telegram.org/` as the api url.
368368
--from-literal=address=https://api.telegram.org
369369
```
370370

371-
Also note that `spec.channel` can be a unique identifier for the target chat
371+
Also note that `spec.channel` can be a unique identifier for the target chat,
372+
a unique identifier with the topic identifier for the forum chat
372373
or username of the target channel (in the format @channelusername)
373374

374375
```yaml
@@ -379,7 +380,7 @@ metadata:
379380
namespace: flux-system
380381
spec:
381382
type: telegram
382-
channel: "@fluxtest" # or "-1557265138" (channel id)
383+
channel: "@fluxtest" # or "-1557265138" (channel id) or "-1552289257:1" (forum chat id with topic id)
383384
secretRef:
384385
name: telegram-token
385386
```

docs/spec/v1beta2/providers.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -563,8 +563,9 @@ The Event will be formatted into a message string, with the metadata attached
563563
as a list of key-value pairs.
564564

565565
The Provider's [Channel](#channel) is used to set the receiver of the message.
566-
This can be a unique identifier (`-1234567890`) for the target chat, or
567-
the username (`@username`) of the target channel.
566+
This can be a unique identifier (`-1234567890`) for the target chat,
567+
a unique identifier with the topic identifier (`-1234567890:1`) for the forum chat,
568+
or the username (`@username`) of the target channel.
568569

569570
This Provider type does not support the configuration of a [proxy URL](#https-proxy)
570571
or [TLS certificates](#tls-certificates).
@@ -586,7 +587,7 @@ metadata:
586587
spec:
587588
type: telegram
588589
address: https://api.telegram.org
589-
channel: "@fluxcd" # or "-1557265138" (channel id)
590+
channel: "@fluxcd" # or "-1557265138" (channel id) or "-1552289257:1" (forum chat id with topic id)
590591
secretRef:
591592
name: telegram-token
592593
```

docs/spec/v1beta3/providers.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -550,8 +550,9 @@ The Event will be formatted into a message string, with the metadata attached
550550
as a list of key-value pairs.
551551

552552
The Provider's [Channel](#channel) is used to set the receiver of the message.
553-
This can be a unique identifier (`-1234567890`) for the target chat, or
554-
the username (`@username`) of the target channel.
553+
This can be a unique identifier (`-1234567890`) for the target chat,
554+
a unique identifier with the topic identifier (`-1234567890:1`) for the forum chat,
555+
or the username (`@username`) of the target channel.
555556

556557
This Provider type does not support the configuration of a [proxy URL](#https-proxy)
557558
or [TLS certificates](#tls-certificates).
@@ -573,7 +574,7 @@ metadata:
573574
spec:
574575
type: telegram
575576
address: https://api.telegram.org
576-
channel: "@fluxcd" # or "-1557265138" (channel id)
577+
channel: "@fluxcd" # or "-1557265138" (channel id) or "-1552289257:1" (forum chat id with topic id)
577578
secretRef:
578579
name: telegram-token
579580
```

0 commit comments

Comments
 (0)