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’s placeholders. Pass an empty table {} if the template needs no data. Values can be strings, numbers, or nested tables, matching the placeholders configured on the template.

boolean

default:"false"

When true, waits for the message to be delivered before returning (so you can read back the messageId). When false, the call returns as soon as the request is accepted.

Returns

table | nil

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

Show result fields

boolean

true when the webhook was accepted/sent.

string

The template that was fired.

string | null

The delivered message id (present when wait is true).

string[]

Any non-fatal warnings raised while rendering/sending.

boolean

On failure, true if the template is currently disabled.

string

On failure, a human-readable reason.

Examples

local BloxCord = game:WaitForChild("BloxCord")

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

local BloxCord = game:WaitForChild("BloxCord")

local result = BloxCord:Invoke("fireWebhook", host, "raid-result", {
    outcome = "Victory",
    duration = "42 minutes",
}, true)

if result and result.success then
    print("Sent message:", result.messageId)
end

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, logbook.revert, logbook.getEntries, logbook.checkRankLock, permissions.get, minutes.get, leaderboard.get, user.getDepartments, user.getProfile, roles.get, liveTables.find, liveTables.items, liveTables.update, points.get, points.update, reputation.get, webhook.fire, session.getReservations, session.getSession, session.startHosting, session.updateAttendees, session.updateMark, session.updateStrike, session.updatePhase, session.updateSession, servers.getRunning.

table

The arguments for that operation.

Returns

array | nil

The per-operation results, in the same order as operations. A failed individual operation yields { error = "message" } in its slot. nil if the whole 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

​Examples

​apiBatch

​Parameters

​Returns

​Example

fireWebhook

Parameters

Returns

Examples

apiBatch

Parameters

Returns

Example