Webhooks & Batch - BloxCord V3

fireWebhook

Fires a webhook using a template configured on the dashboard, optionally passing data to populate it.

local result = BloxCord:Invoke("fireWebhook", actor, templateId, data, wait)

Parameters

Player | table | number

required

Who is firing the webhook. See the actor object.

string

required

The id of the webhook template to fire.

table

required

Key/value data used to populate the template. Pass an empty table {} if the template needs no data. Non-table values are treated as an empty table.

boolean

default:"false"

When true, the backend waits for the webhook delivery before responding.

Returns

table | nil

The delivery result on success, or nil if the request was rejected or the backend was unreachable.

Example

local BloxCord = game:WaitForChild("BloxCord")

BloxCord:Invoke("fireWebhook", host, "shift-started", {
    host = host.Name,
    players = #game.Players:GetPlayers(),
}, false)

apiBatch

Runs multiple operations in a single request. All operations share one actor and are executed sequentially on the backend. This is the most efficient way to perform several writes at once.

local results = BloxCord:Invoke("apiBatch", actor, operations)

A batch may contain at most 20 operations. Duplicate operations within the same batch are rejected. Each operation’s args payload is capped at 24 KB.

Parameters

Player | table | number

required

The actor applied to every operation in the batch. See the actor object.

object[]

required

An array of operation objects to execute in order.

Show operation fields

string

required

The operation name. Allowed values: setRank, logbook.create, points.get, points.update, reputation.get, webhook.fire, session.getReservations, session.startHosting, session.updateAttendees, session.updateMark, session.updateStrike, session.updatePhase, session.updateSession.

table

The arguments for that operation.

Returns

array | nil

The per-operation results from the backend on success, or nil if the batch was rejected or the backend was unreachable.

Example

local BloxCord = game:WaitForChild("BloxCord")

local results = BloxCord:Invoke("apiBatch", host, {
    {
        op = "points.update",
        args = { userId = "123456789", amount = 5, reason = "Attendance" },
    },
    {
        op = "logbook.create",
        args = { userId = "123456789", type = "warning", reason = "Late" },
    },
})

​fireWebhook

​Parameters

​Returns

​Example

​apiBatch

​Parameters

​Returns

​Example

fireWebhook

Parameters

Returns

Example

apiBatch

Parameters

Returns

Example