@@ -144,7 +144,7 @@ The supported providers for [Git commit status updates](#git-commit-status-updat
144
144
When `.spec.type` is set to `generic`, the controller will send an HTTP POST
145
145
request to the provided [Address](#address).
146
146
147
- The body of the request is a [JSON `Event` object](events .md#event-structure),
147
+ The body of the request is a [JSON `Event` object](event .md#event-structure),
148
148
for example :
149
149
150
150
` ` ` json
@@ -191,7 +191,7 @@ referenced Secret](#http-headers-example).
191
191
##### Generic webhook with HMAC
192
192
193
193
When `.spec.type` is set to `generic-hmac`, the controller will send an HTTP
194
- POST request to the provided [Address](#address) for an [Event](events .md#event-structure),
194
+ POST request to the provided [Address](#address) for an [Event](event .md#event-structure),
195
195
while including an `X-Signature` HTTP header carrying the HMAC of the request
196
196
body. The inclusion of the header allows the receiver to verify the
197
197
authenticity and integrity of the request.
@@ -210,7 +210,7 @@ HMAC of the request body, encoded as a hexadecimal string.
210
210
211
211
while `<hash>` is the hex-encoded HMAC value.
212
212
213
- The body of the request is a [JSON `Event` object](events .md#event-structure),
213
+ The body of the request is a [JSON `Event` object](event .md#event-structure),
214
214
as described in the [Generic webhook](#generic-webhook) section.
215
215
216
216
###### HMAC verification example
@@ -283,7 +283,7 @@ func handleRequest(w http.ResponseWriter, r *http.Request) {
283
283
##### Slack
284
284
285
285
When ` .spec.type ` is set to ` slack ` , the controller will send a message for an
286
- [ Event] ( events .md#event-structure) to the provided Slack API [ Address] ( #address ) .
286
+ [ Event] ( event .md#event-structure) to the provided Slack API [ Address] ( #address ) .
287
287
288
288
The Event will be formatted into a Slack message using an [ Attachment] ( https://api.slack.com/reference/messaging/attachments ) ,
289
289
with the metadata attached as fields, and the involved object as author.
@@ -367,7 +367,7 @@ stringData:
367
367
# #### Microsoft Teams
368
368
369
369
When `.spec.type` is set to `msteams`, the controller will send a payload for
370
- an [Event](events .md#event-structure) to the provided Microsoft Teams [Address](#address).
370
+ an [Event](event .md#event-structure) to the provided Microsoft Teams [Address](#address).
371
371
372
372
The Event will be formatted into a Microsoft Teams
373
373
[connector message](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using#example-of-connector-message),
@@ -409,7 +409,7 @@ stringData:
409
409
# #### DataDog
410
410
411
411
When `.spec.type` is set to `datadog`, the controller will send a payload for
412
- an [Event](events .md#event-structure) to the provided DataDog API [Address](#address).
412
+ an [Event](event .md#event-structure) to the provided DataDog API [Address](#address).
413
413
414
414
The Event will be formatted into a [DataDog Event](https://docs.datadoghq.com/api/latest/events/#post-an-event) and sent to the
415
415
API endpoint of the provided DataDog [Address](#address).
@@ -465,7 +465,7 @@ spec:
465
465
##### Discord
466
466
467
467
When ` .spec.type ` is set to ` discord ` , the controller will send a payload for
468
- an [ Event] ( events .md#event-structure) to the provided Discord [ Address] ( #address ) .
468
+ an [ Event] ( event .md#event-structure) to the provided Discord [ Address] ( #address ) .
469
469
470
470
The Event will be formatted into a [ Slack message] ( #slack ) and send to the
471
471
` /slack ` endpoint of the provided Discord [ Address] ( #address ) .
@@ -506,7 +506,7 @@ stringData:
506
506
##### Sentry
507
507
508
508
When ` .spec.type` is set to `sentry`, the controller will send a payload for
509
- an [Event](events .md#event-structure) to the provided Sentry [Address](#address).
509
+ an [Event](event .md#event-structure) to the provided Sentry [Address](#address).
510
510
511
511
Depending on the `severity` of the Event, the controller will capture a [Sentry
512
512
Event](https://develop.sentry.dev/sdk/event-payloads/)for `error`, or [Sentry
@@ -556,7 +556,7 @@ stringData:
556
556
# #### Telegram
557
557
558
558
When `.spec.type` is set to `telegram`, the controller will send a payload for
559
- an [Event](events .md#event-structure) to the provided Telegram [Address](#address).
559
+ an [Event](event .md#event-structure) to the provided Telegram [Address](#address).
560
560
561
561
The Event will be formatted into a message string, with the metadata attached
562
562
as a list of key-value pairs.
@@ -593,7 +593,7 @@ spec:
593
593
# #### Matrix
594
594
595
595
When `.spec.type` is set to `matrix`, the controller will send a payload for
596
- an [Event](events .md#event-structure) to the provided Matrix [Address](#address).
596
+ an [Event](event .md#event-structure) to the provided Matrix [Address](#address).
597
597
598
598
The Event will be formatted into a message string, with the metadata attached
599
599
as a list of key-value pairs, and send as a [`m.room.message` text event](https://spec.matrix.org/v1.3/client-server-api/#mroommessage)
@@ -628,7 +628,7 @@ spec:
628
628
# #### Lark
629
629
630
630
When `.spec.type` is set to `lark`, the controller will send a payload for
631
- an [Event](events .md#event-structure) to the provided Lark [Address](#address).
631
+ an [Event](event .md#event-structure) to the provided Lark [Address](#address).
632
632
633
633
The Event will be formatted into a [Lark Message card](https://open.larksuite.com/document/ukTMukTMukTM/uczM3QjL3MzN04yNzcDN),
634
634
with the metadata written to the message string.
@@ -665,7 +665,7 @@ stringData:
665
665
# #### Rocket
666
666
667
667
When `.spec.type` is set to `rocket`, the controller will send a payload for
668
- an [Event](events .md#event-structure) to the provided Rocket [Address](#address).
668
+ an [Event](event .md#event-structure) to the provided Rocket [Address](#address).
669
669
670
670
The Event will be formatted into a [Slack message](#slack) and send as a
671
671
payload the provided Rocket [Address](#address).
@@ -695,7 +695,7 @@ spec:
695
695
# #### Google Chat
696
696
697
697
When `.spec.type` is set to `googlechat`, the controller will send a payload for
698
- an [Event](events .md#event-structure) to the provided Google Chat [Address](#address).
698
+ an [Event](event .md#event-structure) to the provided Google Chat [Address](#address).
699
699
700
700
The Event will be formatted into a [Google Chat card message](https://developers.google.com/chat/api/reference/rest/v1/cards-v1),
701
701
with the metadata added as a list of [key-value pairs](https://developers.google.com/chat/api/reference/rest/v1/cards-v1#keyvalue)
@@ -733,7 +733,7 @@ stringData:
733
733
# #### Google Pub/Sub
734
734
735
735
When `.spec.type` is set to `googlepubsub`, the controller will publish the payload of
736
- an [Event](events .md#event-structure) on the Google Pub/Sub Topic ID provided in the
736
+ an [Event](event .md#event-structure) on the Google Pub/Sub Topic ID provided in the
737
737
[Channel](#channel) field, which must exist in the GCP Project ID provided in the
738
738
[Address](#address) field.
739
739
@@ -792,7 +792,7 @@ stringData:
792
792
# #### Opsgenie
793
793
794
794
When `.spec.type` is set to `opsgenie`, the controller will send a payload for
795
- an [Event](events .md#event-structure) to the provided Opsgenie [Address](#address).
795
+ an [Event](event .md#event-structure) to the provided Opsgenie [Address](#address).
796
796
797
797
The Event will be formatted into a [Opsgenie alert](https://docs.opsgenie.com/docs/alert-api#section-create-alert-request),
798
798
with the metadata added to the [`details` field](https://docs.opsgenie.com/docs/alert-api#create-alert)
@@ -833,7 +833,7 @@ stringData:
833
833
# #### PagerDuty
834
834
835
835
When `.spec.type` is set to `pagerduty`, the controller will send a payload for
836
- an [Event](events .md#event-structure) to the provided PagerDuty [Address](#address).
836
+ an [Event](event .md#event-structure) to the provided PagerDuty [Address](#address).
837
837
838
838
The Event will be formatted into an [Event API v2](https://developer.pagerduty.com/api-reference/368ae3d938c9e-send-an-event-to-pager-duty) payload,
839
839
triggering or resolving an incident depending on the event's `Severity`.
@@ -891,7 +891,7 @@ spec:
891
891
# #### Prometheus Alertmanager
892
892
893
893
When `.spec.type` is set to `alertmanager`, the controller will send a payload for
894
- an [Event](events .md#event-structure) to the provided Prometheus Alertmanager
894
+ an [Event](event .md#event-structure) to the provided Prometheus Alertmanager
895
895
[Address](#address).
896
896
897
897
The Event will be formatted into a `firing` [Prometheus Alertmanager
@@ -946,7 +946,7 @@ stringData:
946
946
# #### Webex
947
947
948
948
When `.spec.type` is set to `webex`, the controller will send a payload for
949
- an [Event](events .md#event-structure) to the provided Webex [Address](#address).
949
+ an [Event](event .md#event-structure) to the provided Webex [Address](#address).
950
950
951
951
The Event will be formatted into a message string, with the metadata attached
952
952
as a list of key-value pairs, and send as a [Webex message](https://developer.webex.com/docs/api/v1/messages/create-a-message).
@@ -1195,7 +1195,7 @@ for the selected repository. The `repository_dispatch` events can be used to tri
1195
1195
The request includes the `event_type` and `client_payload` fields :
1196
1196
1197
1197
- ` event_type` is generated from the involved object in the format `{Kind}/{Name}.{Namespace}`.
1198
- - ` client_payload` contains the [Flux event](events .md).
1198
+ - ` client_payload` contains the [Flux event](event .md).
1199
1199
1200
1200
# ## Setting up the GitHub dispatch provider
1201
1201
0 commit comments