Skip to content

Commit 0aa8b64

Browse files
committed
update Callback URLs
1 parent 13b1a07 commit 0aa8b64

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

MyApp/_pages/background-jobs.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -635,31 +635,31 @@ public class NotifyCheckUrlsCommand(IHttpClientFactory clientFactory)
635635
`ReplyTo` can be any URL which by default will have the result POST'ed back to the URL with a JSON
636636
Content-Type. Typically URLs will contain a reference Id so external clients can correlate a callback
637637
with the internal process that initiated the job. If the callback API is publicly available you'll
638-
want to use an internal Id that can't be guessed so the callback can't be spoofed, like a Guid, e.g:
638+
want to use an internal Id that can't be guessed (like a Guid) so the callback can't be spoofed, e.g:
639639

640-
`$"https://api.example.com?refId={RefId}"`
640+
`$"https://api.example.com/callback?refId={RefId}"`
641641

642642
If needed the callback URL can be customized on how the HTTP Request callback is sent.
643643

644644
If the URL contains a space, the text before the space is treated as the HTTP method:
645645

646-
`"PUT https://api.example.com"`
646+
`"PUT https://api.example.com/callback"`
647647

648648
If the auth part contains a colon `:` it's treated as Basic Auth:
649649

650-
`"username:password@https://api.example.com"`
650+
`"username:password@https://api.example.com/callback"`
651651

652652
If name starts with `http.` sends a HTTP Header
653653

654-
`"http.X-API-Key:myApiKey@https://api.example.com"`
654+
`"http.X-API-Key:myApiKey@https://api.example.com/callback"`
655655

656656
Otherwise it's sent as a Bearer Token:
657657

658-
`"myToken123@https://api.example.com"`
658+
`"myToken123@https://api.example.com/callback"`
659659

660660
Bearer Token or HTTP Headers starting with `$` is substituted with Environment Variable if exists:
661661

662-
`"$API_TOKEN@https://api.example.com"`
662+
`"$API_TOKEN@https://api.example.com/callback"`
663663

664664
When needed headers, passwords and tokens can be URL encoded if they contain any delimiter characters.
665665

MyApp/_pages/releases/v8_04.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -779,31 +779,31 @@ public class NotifyCheckUrlsCommand(IHttpClientFactory clientFactory)
779779
`ReplyTo` can be any URL which by default will have the result POST'ed back to the URL with a JSON
780780
Content-Type. Typically URLs will contain a reference Id so external clients can correlate a callback
781781
with the internal process that initiated the job. If the callback API is publicly available you'll
782-
want to use an internal Id that can't be guessed so the callback can't be spoofed, like a Guid, e.g:
782+
want to use an internal Id that can't be guessed (like a Guid) so the callback can't be spoofed, e.g:
783783

784-
`$"https://api.example.com?refId={RefId}"`
784+
`$"https://api.example.com/callback?refId={RefId}"`
785785

786786
If needed the callback URL can be customized on how the HTTP Request callback is sent.
787787

788788
If the URL contains a space, the text before the space is treated as the HTTP method:
789789

790-
`"PUT https://api.example.com"`
790+
`"PUT https://api.example.com/callback"`
791791

792792
If the auth part contains a colon `:` it's treated as Basic Auth:
793793

794-
`"username:password@https://api.example.com"`
794+
`"username:password@https://api.example.com/callback"`
795795

796796
If name starts with `http.` sends a HTTP Header
797797

798-
`"http.X-API-Key:myApiKey@https://api.example.com"`
798+
`"http.X-API-Key:myApiKey@https://api.example.com/callback"`
799799

800800
Otherwise it's sent as a Bearer Token:
801801

802-
`"myToken123@https://api.example.com"`
802+
`"myToken123@https://api.example.com/callback"`
803803

804804
Bearer Token or HTTP Headers starting with `$` is substituted with Environment Variable if exists:
805805

806-
`"$API_TOKEN@https://api.example.com"`
806+
`"$API_TOKEN@https://api.example.com/callback"`
807807

808808
When needed headers, passwords and tokens can be URL encoded if they contain any delimiter characters.
809809

0 commit comments

Comments
 (0)