Ask or search…
K
Links

Getting Started

Newcomers introduction to Durable Proxy with Dispatch.
In this tutorial, you will set up a new organization on Dispatch and use its API to send your first HTTP request.

Sign up

If you have not already done so, you can sign up for Dispatch using your GitHub account. At the moment, the product is in private beta. We will give you access shortly after.

Console

After logging in, the web interface you interact with is named the Console. This is where you manage your account, monitor your requests, etc.
When you first get access to the Console, you are automatically logged into your one-person organization.

Creating an API key

To use Dispatch, you must create an API key. You will use this secret key to authenticate against the Dispatch API later in this tutorial.
As this is your first time using Dispatch, you can generate a new key by clicking Generate an API key in the API Keys tab.
Make sure you copy the secret being presented to you somewhere safe!
We do not store secrets. If you lose this secret, you can generate a new one in the API Keys management section.

Your first request

Now that you have your API key, you can send your first HTTP request with Dispatch.
In this tutorial, we will use curl to send the request, but any HTTP client works (Postman, Jetbrain's, etc). Let's make a simple GET request to example.com.
curl \
-H "Proxy-Authorization: Bearer $DISPATCH_API_KEY" \
https://dispatch.stealthrocket.cloud/example.com/
Replacing $DISPATCH_API_KEY with the secret retrieved at the previous step.
Dispatch replies with a console URL ending with the task ID! This unique identifier refers to the request you asked Dispatch to perform.

The result

Refresh the console page, and you should see your request! If you were very quick, you would see it as in progress, meaning Dispatch is still working on it for you. However, it is likely shown as 200, a success.
Click the show link next to your request to see the exchange details. Here, you can dig into what request was sent on your behalf and which response was received.

Next up

Now that you have the basics covered, here are a few next steps to consider:
  • Send more requests!
  • Read up the HTTP API to learn everything possible with the Durable Proxy.
  • Invite colleagues to your organization to start building together (Settings -> Collaborators).
©️ Stealth Rocket, Inc. All rights reserved.