Skip to content

Commit bac77d8

Browse files
Fix: improve qstash url/token (#760)
* feat: improve qstash url/token descriptions * feat: add workflow get-token page, link quickstarts to token sections * chore(llms): regenerate llms.txt and llms-full.txt --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent bc0df7d commit bac77d8

25 files changed

Lines changed: 89 additions & 37 deletions

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1371,6 +1371,7 @@
13711371
"workflow/howto/configure",
13721372
"workflow/howto/cancel",
13731373
"workflow/howto/security",
1374+
"workflow/howto/get-token",
13741375
"workflow/howto/readonly-token",
13751376
"workflow/howto/redact-fields",
13761377
"workflow/howto/changes",
49.3 KB
Loading
-139 KB
Binary file not shown.
53.2 KB
Loading

img/qstash/rest_token.png

-67.7 KB
Binary file not shown.

llms-full.txt

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10854,8 +10854,9 @@ Source: https://upstash.com/docs/qstash/features/security
1085410854

1085510855
### Request Authorization
1085610856

10857-
When interacting with the QStash API, you will need an authorization token. You
10858-
can get your token from the [Console](https://console.upstash.com/qstash).
10857+
When interacting with the QStash API, you will need an authorization token. To
10858+
get your token, go to the [QStash tab in the Console](https://console.upstash.com/qstash),
10859+
pick a region, and copy the `QSTASH_TOKEN` from the **Quickstart** section.
1085910860

1086010861
<img />
1086110862

@@ -11436,6 +11437,12 @@ QStash is available in two regions: **EU region** and **US region**. Each region
1143611437
* **EU Region**: `https://qstash-eu-central-1.upstash.io`, or `https://qstash.upstash.io`
1143711438
* **US Region**: `https://qstash-us-east-1.upstash.io`
1143811439

11440+
`QSTASH_URL` is optional. When it is not set, SDKs default to the EU region
11441+
(`https://qstash.upstash.io`). To use the US region, set `QSTASH_URL` to the US
11442+
regional URL together with that region's `QSTASH_TOKEN` and signing keys — you can
11443+
copy all of them from the **Quickstart** section of the
11444+
[QStash Console](https://console.upstash.com/qstash).
11445+
1143911446
## Key Concepts
1144011447

1144111448
Each QStash region maintains:
@@ -13901,10 +13908,11 @@ messages to. If you don't, you can use something like
1390113908

1390213909
For example, you can use this URL to test your messages: [https://firstqstashmessage.requestcatcher.com](https://firstqstashmessage.requestcatcher.com)
1390313910

13904-
### Get your token
13911+
### Get your QStash Token
1390513912

13906-
Go to the [Upstash Console](https://console.upstash.com/qstash) and copy the
13907-
`QSTASH_TOKEN`.
13913+
Go to the [QStash tab in the Upstash Console](https://console.upstash.com/qstash),
13914+
pick the region you want to use (see [Select a Region](/docs/qstash/howto/multi-region)),
13915+
and copy the `QSTASH_TOKEN` from the **Quickstart** section.
1390813916

1390913917
<img />
1391013918

@@ -49410,6 +49418,22 @@ For example, let's debug the following failed run. Judging by the status code `4
4941049418
# Flow control
4941149419
Source: https://upstash.com/docs/workflow/howto/flow-control
4941249420

49421+
# Get your QStash Token
49422+
Source: https://upstash.com/docs/workflow/howto/get-token
49423+
49424+
Upstash Workflow is powered by [QStash](/docs/qstash/overall/getstarted), so your app
49425+
authenticates with a QStash token. Go to the
49426+
[Workflow tab in the Upstash Console](https://console.upstash.com/workflow), pick
49427+
the region you want to use, and copy the `QSTASH_TOKEN` from the **Quickstart**
49428+
section.
49429+
49430+
<img />
49431+
49432+
<Info>
49433+
If you want to safely share a token with your team or AI agents, you can use a
49434+
[read-only token](/docs/workflow/howto/readonly-token) instead.
49435+
</Info>
49436+
4941349437
# Development Server
4941449438
Source: https://upstash.com/docs/workflow/howto/local-development/development-server
4941549439

llms.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1046,6 +1046,7 @@
10461046
- [Configure a Run](https://upstash.com/docs/workflow/howto/configure.md)
10471047
- [Handle Failed Runs](https://upstash.com/docs/workflow/howto/failures.md)
10481048
- [Flow control](https://upstash.com/docs/workflow/howto/flow-control.md)
1049+
- [Get your QStash Token](https://upstash.com/docs/workflow/howto/get-token.md)
10491050
- [Development Server](https://upstash.com/docs/workflow/howto/local-development/development-server.md)
10501051
- [Local Tunnel](https://upstash.com/docs/workflow/howto/local-development/local-tunnel.md)
10511052
- [Middlewares](https://upstash.com/docs/workflow/howto/middlewares.md)

qstash/features/security.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ title: "Security"
44

55
### Request Authorization
66

7-
When interacting with the QStash API, you will need an authorization token. You
8-
can get your token from the [Console](https://console.upstash.com/qstash).
7+
When interacting with the QStash API, you will need an authorization token. To
8+
get your token, go to the [QStash tab in the Console](https://console.upstash.com/qstash),
9+
pick a region, and copy the `QSTASH_TOKEN` from the **Quickstart** section.
910

1011
<Frame>
11-
<img src="/img/qstash/rest_token.png" />
12+
<img src="/img/qstash/console-quickstart-env.jpg" />
1213
</Frame>
1314

1415
Send this token along with every request made to `QStash` inside the

qstash/howto/multi-region.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ QStash is available in two regions: **EU region** and **US region**. Each region
1111
- **EU Region**: `https://qstash-eu-central-1.upstash.io`, or `https://qstash.upstash.io`
1212
- **US Region**: `https://qstash-us-east-1.upstash.io`
1313

14+
`QSTASH_URL` is optional. When it is not set, SDKs default to the EU region
15+
(`https://qstash.upstash.io`). To use the US region, set `QSTASH_URL` to the US
16+
regional URL together with that region's `QSTASH_TOKEN` and signing keys — you can
17+
copy all of them from the **Quickstart** section of the
18+
[QStash Console](https://console.upstash.com/qstash).
19+
1420
## Key Concepts
1521

1622
Each QStash region maintains:

qstash/overall/getstarted.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,14 @@ messages to. If you don't, you can use something like
6161

6262
For example, you can use this URL to test your messages: [https://firstqstashmessage.requestcatcher.com](https://firstqstashmessage.requestcatcher.com)
6363

64-
### Get your token
64+
### Get your QStash Token
6565

66-
Go to the [Upstash Console](https://console.upstash.com/qstash) and copy the
67-
`QSTASH_TOKEN`.
66+
Go to the [QStash tab in the Upstash Console](https://console.upstash.com/qstash),
67+
pick the region you want to use (see [Select a Region](/qstash/howto/multi-region)),
68+
and copy the `QSTASH_TOKEN` from the **Quickstart** section.
6869

6970
<Frame>
70-
<img src="/img/qstash/rest_token.png" />
71+
<img src="/img/qstash/console-quickstart-env.jpg" />
7172
</Frame>
7273

7374
### Publish a message

0 commit comments

Comments
 (0)