HTTP¶

Your bot's passport to the outside world — call any REST API, payment gateway, or weather service without leaving your command's Logic field.

For Telegram stuff, use Api. For everything else on the internet, use HTTP.

What is HTTP?¶

The HTTP instance lets your bot make outbound requests to external APIs, websites, and services — GET, POST, PUT, and more — directly from command scripts.

Use HTTP when you need data or actions outside Telegram. For Telegram API calls, use Api.

How to use it¶

Drop this in any command's Logic field:

let res = await HTTP.get("https://api.example.com/status")

if (res.ok) {
  Bot.sendMessage("API says: " + res.data.message)
}

Three things worth knowing upfront:

1. All methods return a Promise — use await.
2. Requests don't throw on HTTP errors — check res.ok instead.
3. Store API tokens in ENV vars — never hard-code secrets. See process.env.

HTTP or Api?¶

Try it — copy-paste examples¶

Start simple. Each example only introduces what it needs.

GET request¶

let res = await HTTP.get("https://api.example.com/users", { query: { page: 1 } })

if (res.ok) {
  Bot.sendMessage("Found " + res.data.length + " users")
}

POST with a body¶

Store your API token in dashboard ENV settings:

let res = await HTTP.post("https://api.example.com/notify", {
  body: { user_id: user.id, event: "signup" },
  headers: { Authorization: "Bearer " + process.env.API_TOKEN },
  timeout: 10000,
  responseType: "json"
})

if (!res.ok) {
  Bot.sendMessage("Could not reach server (" + res.status + ")")
  return
}

Bot.sendMessage("Registered! ID: " + res.data.id)

ENV setup: process.env

Chain to another command¶

Run /onSuccess or /onError when the request finishes — no await needed:

HTTP.get({
  url: "https://api.example.com/data",
  success: "/onSuccess",
  error: "/onError",
  tbl_options: { requestId: "abc" }
})

Inside callback commands, response data is available via http_response, response, content, headers, and cookies. See Fallback Commands.

How it works¶

HTTP is a dynamic method proxy — any HTTP verb works as a method name:

HTTP.get(url, options?)
HTTP.post(url, options?)
HTTP.put(url, options?)
HTTP.patch(url, options?)
HTTP.delete(url, options?)
HTTP.head(url, options?)
HTTP.options(url, options?)

Two call styles:

// URL string + options object
await HTTP.get("https://api.example.com/users", { query: { page: 1 } })

// Single options object (url inside)
await HTTP.post({
  url: "https://api.example.com/users",
  body: { name: "Alice" },
  success: "/onCreated"
})

All methods return a Promise with a response object. Requests do not throw on HTTP errors — check res.ok instead.

Routing through proxies¶

Deploy cf-http-router to get a free *.workers.dev cfProxy endpoint.

Availability¶

Pages in this section¶