Cloudflare Workers
This is a step by step guide on how to receive webhooks from QStash in your Cloudflare Worker.
Project Setup
We will use C3 (create-cloudflare-cli) command-line tool to create our functions. You can open a new terminal window and run C3 using the prompt below.
This will install the create-cloudflare
package, and lead you through setup. C3 will also install Wrangler in projects by default, which helps us testing and deploying the projects.
We will also install the Upstash QStash library.
3. Use QStash in your handler
First we import the library:
Then we adjust the Env
interface to include the QSTASH_CURRENT_SIGNING_KEY
and QSTASH_NEXT_SIGNING_KEY
environment variables.
And then we validate the signature in the handler
function.
First we create a new receiver and provide it with the signing keys.
Then we verify the signature.
The entire file looks like this now:
Configure Credentials
There are two methods for setting up the credentials for QStash. The recommended way is to use Cloudflare Upstash Integration. Alternatively, you can add the credentials manually.
Using the Cloudflare Integration
Access to the Cloudflare Dashboard and login with the same account that you’ve used while setting up the Worker application. Then, navigate to Workers & Pages > Overview section on the sidebar. Here, you’ll find your application listed.
Clicking on the application will direct you to the application details page, where you can perform the integration process. Switch to the Settings tab in the application details, and proceed to Integrations section. You will see various Worker integrations listed. To proceed, click the Add Integration button associated with the QStash.
On the Integration page, connect to your Upstash account. Then, select the related database from the dropdown menu. Finalize the process by pressing Save button.
Setting up Manually
Navigate to Upstash Console and copy/paste your QStash credentials to wrangler.toml
as below.
Test and Deploy
You can test the function locally with npx wrangler dev
Deploy your function to Cloudflare with npx wrangler deploy
The endpoint of the function will be provided to you, once the deployment is done.
Publish a message
Open a different terminal and publish a message to QStash. Note the destination url is the same that was printed in the previous deploy step.
In the logs you should see something like this:
Next Steps
That’s it, you have successfully created a secure Cloudflare Worker, that receives and verifies incoming webhooks from qstash.
Learn more about publishing a message to qstash here.
You can find the source code here.
Was this page helpful?