Vertex Scripts
ModulesHttp

Server

Makes a request to a url and returns the response.

Classes

VxHttpResponse

  • status: number
  • ok: boolean
    • True if the status code is > 199 and < 300
  • data?: table
  • errorText?: string
  • headers: table<string, any>

VxHttpRequest

  • method: string
    • "GET" | "POST" | "PUT" | "DELETE" | "PATCH"
  • body?: any
  • headers?: table<string, any>

vx.sendHttpRequest

vx.sendHttpRequest(request)
  • request: VxHttpRequest
  • Returns: VxHttpResponse

Example

local response = vx.sendHttpRequest({
  method = "GET",
  url = "https://jsonplaceholder.typicode.com/todos/1",
})
 
local response = vx.sendHttpRequest(webhook, {
  method = "POST",
  body = json.encode(embed),
  headers = { ['Content-Type'] = 'application/json' }
})

Previous

Shared

Next

Client

On this page

ClassesVxHttpResponseVxHttpRequestvx.sendHttpRequestExample