Build a request

A request holds everything Collapy needs to make one HTTP call. You build it in a request tab, save it to your workspace, and send it whenever you need it.

Create a request

You can start a new request from any of these places:

Where	What to click
EXPLORER panel header	The + button (tooltip New Request)
Tab bar	The + button (tooltip New tab) → New Request
A collection's tab	New Request in the toolbar — the new request is placed in that collection
Welcome tab	New Request

A New Request tab opens. To create the request:

1. Type a name in Request title.
2. Optionally click the collection field (it shows None (Root level) by default) to pick a collection.
3. Choose the method and enter the URL.
4. Fill in any parameters, headers, body or auth you need.
5. Click Create.

Create stays disabled until the request has both a title and a URL. You can send the request once it has been created.

Method

Pick the method from the drop-down at the left of the URL bar. Collapy supports:

GET · POST · PUT · PATCH · DELETE

HEAD and OPTIONS aren't supported.

URL bar

Type the full URL, including http:// or https://. Collapy checks the URL as you type and shows a message under the bar if something is wrong:

Message	What to fix
URL must start with http:// or https://	Add the scheme, for example https://api.example.com/users.
URL must have a host	Add a host name after the scheme.
Invalid URL format	The URL can't be parsed — check for typos.

A URL that starts with a variable, such as {{baseUrl}}/users, isn't checked until you send it.

The URL bar highlights two kinds of placeholders:

• {{name}} — an environment variable. Type {{ to get suggestions from the active environment. See Variables.
• :name — a path variable, filled in from the Params tab. See Path variables.

To check what will actually be sent, press and hold the eye button in the toolbar, or hold Ctrl+E (Cmd+E on macOS). Variables are shown with their current values while you hold it; secret values stay hidden. The button only works when an environment is selected.

Toolbar

The toolbar at the top of a saved request has:

Button	What it does
Request title	Click it to rename the request.
Save	Saves your changes. Disabled when there's nothing to save.
Send	Sends the request. Shows Sending... while the request is in flight. See Send a request and read the response.
Eye button	Hold to preview resolved variable values.
Pin button	Pin / Unpin the request so it appears in the PINNED panel.
⋮ menu	Pin / Unpin, Duplicate, Delete.

When an environment is selected, the Send button takes the colour of that environment's type, so you can see at a glance where the request is going.

Request tabs

Below the URL bar, a request has these tabs:

Tab	What it's for
Params	Query parameters, and path variables when the URL has any.
Auth	How the request authenticates. See Authentication.
Headers	HTTP headers.
Body	The request body. See Request body.
Executions	Recent sends of this request. See Execution history.
Change Log	Who changed the request, when and what changed. Available on the Ultra plan.
Info	Description, collection, visibility and details.

Executions and Change Log appear once the request has been created. The Params and Headers tabs show a count of filled-in rows.

Query parameters

The Params tab has a QUERY PARAMETERS table with Key, Value and Description columns.

• The URL bar and the table stay in sync. Type ?page=2&limit=20 in the URL and two rows appear; add a row and it's added to the URL.
• Untick the checkbox on a row to keep it without sending it. Disabled rows are removed from the URL but stay in the table.
• If two rows use the same key, the key is marked Duplicate key.
• Keys and values can contain {{variables}}.
• Press Enter in the last column to move to the next row, or to add a new row at the end of the table.

Headers

The Headers tab has an HTTP HEADERS table with Header Name, Value and Description columns. It works like the query parameters table: untick a row to stop sending it, and duplicate names are marked Duplicate key.

To add a well-known header, click Add common header (the button next to the table title) and choose one, for example Content-Type, Accept or Authorization. Headers you've already added aren't offered again.

You usually don't need to add Content-Type yourself — Collapy sets it from the body type. See Request body.

Info tab

Section	What it shows
Description	Free-text notes about the request.
Collection	The collection the request belongs to, or None (Root level). Click it to move the request.
Visibility	The Private switch. On: Only you can access this request. Off: Workspace members can access this request.
Information	The request's ID, Collection ID, Created and Updated times. Requests created by a synced workspace also show API Version and Import Identity.

Save your changes

Edits aren't saved to the workspace until you save them.

• Click Save or press Ctrl+S (Cmd+S on macOS).
• A tab with unsaved changes shows a dot next to its title, and the footer shows how many tabs are unsaved.
• Unsaved edits are kept on your device, per workspace. If you reload the page or come back later, your draft is still there. Other members only see your changes after you save.
• Send always uses what's currently in the editor, including unsaved changes.

If you close a tab that has unsaved changes, Collapy asks what to do:

• Save — save, then close.
• Discard — close and throw the changes away.
• Cancel — keep the tab open.

Duplicate a request

Choose ⋮ → Duplicate, or press Ctrl+D (Cmd+D on macOS) while the request tab is active and the cursor isn't in a text field.

The copy is named <title> (Copy), is placed in the same collection and opens in a new tab. It's made from the last saved version — unsaved edits aren't copied.

Delete a request

1. Choose ⋮ → Delete.
2. Confirm with Delete.

The tab closes and the request disappears from the Explorer. A Request deleted message with Undo appears — click Undo within 8 seconds to bring the request back. After that the deletion is final.

FAQ

Can I send a request before I create it?

No. Click Create first. Send and Ctrl+Enter are available once the request exists.

Why did a query parameter disappear from the table when I edited the URL?

The table follows the URL. If you remove an enabled parameter from the URL, its row is removed too. Disabled rows are kept.

Related

• Path variables
• Request body
• Authentication
• Send a request and read the response
• Collections and the Explorer
• Variables
• Keyboard shortcuts