Invites and Webhooks

createWebhookClient#

createWebhookClient(options: WebhookClientOptions): WebhookClientcreateWebhookClient(
  options: WebhookClientOptions
): WebhookClient

import { createWebhookClient } from "@neontechspace/fluxerly"
export async function webhookExample(id, token) {
    await using webhook = createWebhookClient({ id, token })
    const message = await webhook.send({ content: "Deploying…" })
    return message.isErr() ? message : await webhook.editMessage(message.value.id, { content: "Deployed" })
}

import { createWebhookClient } from "@neontechspace/fluxerly"
export async function webhookExample(id: string, token: string) {
    await using webhook = createWebhookClient({ id, token })
    const message = await webhook.send({ content: "Deploying…" })
    return message.isErr() ? message : await webhook.editMessage(message.value.id, { content: "Deployed" })
}

WebhookType#

const WebhookType: Readonly<{ … }>

ChannelFollower#

A webhook created when a text channel follows an announcement channel

2

Incoming#

A webhook that accepts messages through its own secret token

1

ChannelFollowerWebhook#

interface ChannelFollowerWebhook extends WebhookBaseinterface ChannelFollowerWebhook
  extends WebhookBase

sourceChannel optional#

Followed channel while it exists and the original creator can view it

Absence does not prove deletion

WebhookSourceChannel

sourceGuild optional#

Source community while it exists and the original creator can view it

Absence does not prove deletion

WebhookSourceGuild

type#

Always WebhookType.ChannelFollower

2

Inherited from WebhookBase: avatar, channelId, guildId, id, name

CreatedWebhook#

interface CreatedWebhook

credentials#

Secret-bearing object for createWebhookClient

Closing a client does not erase this separate object

WebhookCredentials

webhook#

Frozen incoming webhook details, without the required token held separately in credentials

IncomingWebhook

IncomingWebhook#

interface IncomingWebhook extends WebhookBaseinterface IncomingWebhook
  extends WebhookBase

type#

Always WebhookType.Incoming

1

Inherited from WebhookBase: avatar, channelId, guildId, id, name

Invite#

interface Invite

channel#

Minimal destination channel identity, not a full channel snapshot

id

Decimal destination channel ID, not the invitation code

string

name optional

Destination channel name

Null means no name, omission means Fluxer did not supply it

string | null

type

Numeric Fluxer channel type

This can describe a community channel or a private group conversation

number

code#

Provider code, not a full URL

The SDK never includes it in errors or diagnostics

string

expiresAt optional#

ISO 8601 expiry

Null means no expiry, omission means unavailable

string | null

guild optional#

Present for community invites only

Not a full guild snapshot

id

Decimal ID of the community this invitation leads to

string

name

Community name returned with this invitation

string

inviterId optional#

Creator ID

Null means no creator, omission means unavailable

string | null

memberCount#

Observed destination member count

number

presenceCount optional#

Observed presence count, available for community invites

number

temporary#

Whether Fluxer treats membership gained through this invite as temporary

boolean

type#

Community invite or invitation to an existing group DM

"group" | "guild"

url#

Invite URL built from the selected instance's discovered invite base and an encoded code, ready to share with intended recipients

Does not check expiry or joinability. Not a credential-safe value for diagnostics or public logs

string

InviteCreate#

interface InviteCreate

export function inviteExample(client, channelId) {
    return client.invites.create(channelId)
}
export function shareInviteExample(invite) {
    return { content: invite.url }
}

import type { Client } from "@neontechspace/fluxerly"
export function inviteExample(client: Client, channelId: string) {
    return client.invites.create(channelId)
}
export function shareInviteExample(invite: import("@neontechspace/fluxerly").Invite) {
    return { content: invite.url }
}

maxAgeSeconds optional#

Lifetime in seconds, integer 0–604800

Default 86400. Zero requests no expiry

number

maxUses optional#

Maximum uses, integer 0–100

Default zero means unlimited uses until expiry

number

temporary optional#

Default false

True requests temporary community membership, which Fluxer can remove after disconnect

boolean

unique optional#

Default true requests a new code

False permits Fluxer to reuse a matching existing invite

boolean

InviteMetadata#

interface InviteMetadata extends Inviteinterface InviteMetadata
  extends Invite

createdAt#

ISO 8601 creation time

string

maxAgeSeconds optional#

Configured lifetime in seconds

Zero means no expiry. Fluxer omits this for group invites

number

maxUses#

Zero means unlimited uses until expiry

number

uses#

Observed uses, which may change immediately

number

Inherited from Invite: channel, code, expiresAt, guild, inviterId, memberCount, presenceCount, temporary, type, url

Invites#

interface Invites

create(
    channelId: string,
    input?: InviteCreate,
    options?: AuditedRequestOptions
): ResultAsync<
    InviteMetadata,
    ConfigurationError | GuildOperationFailure | CancelledError
>create(
  channelId: string,
  input?: InviteCreate,
  options?: AuditedRequestOptions
): ResultAsync<
  InviteMetadata,
  | ConfigurationError
  | GuildOperationFailure
  | CancelledError
>

delete(code: string, options?: AuditedRequestOptions): ResultAsync<
    void,
    ConfigurationError | GuildOperationFailure | CancelledError
>delete(
  code: string,
  options?: AuditedRequestOptions
): ResultAsync<
  void,
  | ConfigurationError
  | GuildOperationFailure
  | CancelledError
>

fetch(code: string, options?: RequestOptions): ResultAsync<
    Invite,
    ConfigurationError | GuildOperationFailure | CancelledError
>fetch(
  code: string,
  options?: RequestOptions
): ResultAsync<
  Invite,
  | ConfigurationError
  | GuildOperationFailure
  | CancelledError
>

fetchForChannel(
    channelId: string,
    options?: RequestOptions
): ResultAsync<
    readonly InviteMetadata[],
    ConfigurationError | GuildOperationFailure | CancelledError
>fetchForChannel(
  channelId: string,
  options?: RequestOptions
): ResultAsync<
  readonly InviteMetadata[],
  | ConfigurationError
  | GuildOperationFailure
  | CancelledError
>

fetchForGuild(
    guildId: string,
    options?: RequestOptions
): ResultAsync<
    readonly InviteMetadata[],
    ConfigurationError | GuildOperationFailure | CancelledError
>fetchForGuild(
  guildId: string,
  options?: RequestOptions
): ResultAsync<
  readonly InviteMetadata[],
  | ConfigurationError
  | GuildOperationFailure
  | CancelledError
>

UnknownWebhook#

interface UnknownWebhook
    extends WebhookBase, Omit<ChannelFollowerWebhook, "type">interface UnknownWebhook
  extends WebhookBase, Omit<
    ChannelFollowerWebhook,
    "type"
  >

rawType#

Numeric webhook kind Fluxer sent, outside the known WebhookType constants

number

type#

Always "unknown"

"unknown"

Inherited from WebhookBase: avatar, channelId, guildId, id, name

Inherited from ChannelFollowerWebhook: sourceChannel, sourceGuild

WebhookBase#

interface WebhookBase

avatar#

Identifier for the webhook's avatar image, not a complete URL

Null means no custom avatar

string | null

channelId#

ID of the channel that receives its messages, as last reported by Fluxer

string

guildId#

ID of the community that owns this webhook

string

id#

Webhook identifier, kept as a decimal string to avoid JavaScript number rounding

string

name#

Default sender name shown on webhook messages

string

type#

A WebhookType constant, or "unknown" for a kind this SDK version does not know

Compare it to select the matching shape

"unknown" | 2 | 1

WebhookClient#

interface WebhookClient extends AsyncDisposableinterface WebhookClient
  extends AsyncDisposable

id#

The webhook's decimal ID, without its token or a token-bearing URL

string

instance#

Resolve this webhook client's selected instance and get pure URL helpers for it

Instance

[asyncDispose](): Promise<void>

delete(options?: RequestOptions): ResultAsync<
    void,
    ConfigurationError | WebhookOperationFailure | CancelledError
>delete(
  options?: RequestOptions
): ResultAsync<
  void,
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

deleteMessage(
    messageId: string,
    options?: WebhookMessageOperationOptions
): ResultAsync<
    void,
    ConfigurationError | WebhookOperationFailure | CancelledError
>deleteMessage(
  messageId: string,
  options?:
    WebhookMessageOperationOptions
): ResultAsync<
  void,
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

edit(
    input: WebhookTokenEdit,
    options?: RequestOptions
): ResultAsync<
    IncomingWebhook,
    ConfigurationError | WebhookOperationFailure | CancelledError
>edit(
  input: WebhookTokenEdit,
  options?: RequestOptions
): ResultAsync<
  IncomingWebhook,
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

editMessage(
    messageId: string,
    input: string | WebhookMessageEdit,
    options?: WebhookMessageOperationOptions
): ResultAsync<
    Message,
    ConfigurationError | WebhookOperationFailure | CancelledError
>editMessage(
  messageId: string,
  input:
    | string | WebhookMessageEdit,
  options?:
    WebhookMessageOperationOptions
): ResultAsync<
  Message,
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

fetch(options?: RequestOptions): ResultAsync<
    IncomingWebhook,
    ConfigurationError | WebhookOperationFailure | CancelledError
>fetch(
  options?: RequestOptions
): ResultAsync<
  IncomingWebhook,
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

fetchMessage(
    messageId: string,
    options?: WebhookMessageOperationOptions
): ResultAsync<
    Message,
    ConfigurationError | WebhookOperationFailure | CancelledError
>fetchMessage(
  messageId: string,
  options?:
    WebhookMessageOperationOptions
): ResultAsync<
  Message,
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

send(
    input: string | WebhookMessageInput,
    options?: RequestOptions
): ResultAsync<
    Message,
    ConfigurationError | WebhookOperationFailure | CancelledError
>send(
  input:
    | string | WebhookMessageInput,
  options?: RequestOptions
): ResultAsync<
  Message,
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

shutdown(): ResultAsync<void, never>

WebhookCreate#

interface WebhookCreate

avatar optional#

Base64 image data URI, or null for the default avatar

Fluxer validates image format and size

string | null

name#

Default sender name, 1–80 UTF-16 code units after U+000C and U+202E removal and surrounding-whitespace trimming

The original string is sent unchanged

string

WebhookCredentials#

interface WebhookCredentials

id#

ID of the webhook this secret belongs to

string

revealToken(): string

WebhookEdit#

interface WebhookEdit

avatar optional#

Base64 image data URI, or null to remove the avatar

Follower webhooks reject any supplied avatar change

string | null

channelId optional#

Move future messages within the same community, subject to Fluxer's permissions

Followers require a text channel, while incoming webhooks allow text, voice or announcement channels

string

name optional#

New default sender name, 1–80 UTF-16 code units after U+000C and U+202E removal and surrounding-whitespace trimming

The original string is sent unchanged

string

WebhookForumPostOptions#

interface WebhookForumPostOptions

appliedTagIds optional#

IDs of the tags to apply to the new post, at most 5

This needs threadName. Fluxer rejects an ID that the channel does not have, a moderated tag because a webhook cannot manage threads, and a post with no tag when the channel has ChannelFlags.RequireTag

readonly string[]

threadName optional#

Name of the new post, 1–100 UTF-16 code units after U+000C and U+202E removal and surrounding-whitespace trimming

The original string is sent unchanged. The message becomes the first message of the new post, and the result is that message, whose channelId is the new post's ID. Fluxer needs this or threadId to place a message in a forum or media channel, and it cannot be combined with threadId

string

WebhookForwardReference#

interface WebhookForwardReference

source#

Source message and optional attachment/embed selections

Fluxer copies the message without a separate SDK fetch. A source nonce is used only when the message has no top-level nonce. Supplying both fails locally, even if equal

ForwardMessageInput

type#

Select forwarding rather than a reply with newly written content

"forward"

WebhookMessageEdit#

interface WebhookMessageEdit

allowedMentions optional#

Which mentions in the edited message may notify people

Notifications are disabled by default for this edit

AllowedMentions

content optional#

New message text, or an empty string to remove the existing text

string

embeds optional#

New rich-message cards as plain objects or EmbedBuilder instances, or an empty array to remove the existing embeds

readonly (EmbedInput | EmbedBuilder)[]

flags optional#

Replace only MessageFlags.SuppressEmbeds and MessageFlags.SuppressNotifications

Omit to preserve them, or use zero to clear both. Crossposted, IsCrosspost and SourceMessageDeleted are server-managed. Those bits and VoiceMessage fail locally before dispatch

number

WebhookReplyReference#

interface WebhookReplyReference

target#

Message ID and channel ID to reply to

Fluxer checks that the message exists, is replyable and is in the destination channel

MessageReference

type#

Select reply behavior rather than copying a message as a forward

"reply"

WebhookSourceChannel#

interface WebhookSourceChannel

id#

Decimal ID of the followed announcement channel

string

name#

Source channel name when Fluxer returned this snapshot

string

WebhookSourceGuild#

interface WebhookSourceGuild

icon optional#

Community icon hash, not a complete URL

Null means no icon, and omission means unavailable

string | null

id#

Decimal ID of the source community

string

name#

Source community name when Fluxer returned this snapshot

string

WebhookTokenEdit#

interface WebhookTokenEdit

avatar optional#

Base64 image data URI, or null to remove the avatar

string | null

name optional#

New default sender name, 1–80 UTF-16 code units after U+000C and U+202E removal and surrounding-whitespace trimming

The original string is sent unchanged

string

Webhooks#

interface Webhooks

create(
    channelId: string,
    input: WebhookCreate,
    options?: AuditedRequestOptions
): ResultAsync<
    CreatedWebhook,
    ConfigurationError | WebhookOperationFailure | CancelledError
>create(
  channelId: string,
  input: WebhookCreate,
  options?: AuditedRequestOptions
): ResultAsync<
  CreatedWebhook,
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

delete(id: string, options?: AuditedRequestOptions): ResultAsync<
    void,
    ConfigurationError | WebhookOperationFailure | CancelledError
>delete(
  id: string,
  options?: AuditedRequestOptions
): ResultAsync<
  void,
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

edit(
    id: string,
    input: WebhookEdit,
    options?: AuditedRequestOptions
): ResultAsync<
    Webhook,
    ConfigurationError | WebhookOperationFailure | CancelledError
>edit(
  id: string,
  input: WebhookEdit,
  options?: AuditedRequestOptions
): ResultAsync<
  Webhook,
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

fetch(id: string, options?: AuditedRequestOptions): ResultAsync<
    Webhook,
    ConfigurationError | WebhookOperationFailure | CancelledError
>fetch(
  id: string,
  options?: AuditedRequestOptions
): ResultAsync<
  Webhook,
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

fetchForChannel(
    channelId: string,
    options?: AuditedRequestOptions
): ResultAsync<
    readonly Webhook[],
    ConfigurationError | WebhookOperationFailure | CancelledError
>fetchForChannel(
  channelId: string,
  options?: AuditedRequestOptions
): ResultAsync<
  readonly Webhook[],
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

fetchForGuild(
    guildId: string,
    options?: AuditedRequestOptions
): ResultAsync<
    readonly Webhook[],
    ConfigurationError | WebhookOperationFailure | CancelledError
>fetchForGuild(
  guildId: string,
  options?: AuditedRequestOptions
): ResultAsync<
  readonly Webhook[],
  | ConfigurationError
  | WebhookOperationFailure
  | CancelledError
>

Webhook#

type Webhook =
    IncomingWebhook | ChannelFollowerWebhook | UnknownWebhooktype Webhook =
    | IncomingWebhook
    | ChannelFollowerWebhook
    | UnknownWebhook

WebhookClientOptions#

type WebhookClientOptions =
    & (
          | { readonly id: string; readonly token: string }
          | WebhookCredentials)
    & {
          readonly instance?: InstanceOptions
          readonly logging?: LoggingOptions
          readonly uploadMaxBytes?: number
      }type WebhookClientOptions =
    & (
        | {
            readonly id: string
            readonly token: string
          }
        | WebhookCredentials)
    & {
        readonly instance?:
          InstanceOptions
        readonly logging?:
          LoggingOptions
        readonly uploadMaxBytes?:
          number
      }

WebhookMessageInput#

type WebhookMessageInput =
    | MessageBody
      & WebhookMessageOptions
      & WebhookForumPostOptions
      & { readonly messageReference?: WebhookReplyReference }
    | WebhookMessageOptions
      & { readonly messageReference: WebhookForwardReference }type WebhookMessageInput =
    | MessageBody
      & WebhookMessageOptions
      & WebhookForumPostOptions
      & {
          readonly messageReference?:
            WebhookReplyReference
        }
    | WebhookMessageOptions
      & {
          readonly messageReference:
            WebhookForwardReference
        }

WebhookMessageOptions#

type WebhookMessageOptions = { … }

allowedMentions optional#

Which mentions may notify people

By default, mention text does not enable notifications

AllowedMentions

avatarUrl optional#

Override the avatar for this message only

Use an HTTP(S) URL without credentials, at most 8,192 characters, fetched by Fluxer

string

flags optional#

Message behavior flags from MessageFlags

Only SuppressEmbeds and SuppressNotifications are writable, and omission uses Fluxer's default. Crossposted, IsCrosspost and SourceMessageDeleted are server-managed. Those bits and VoiceMessage fail locally before dispatch

number

nonce optional#

Application-chosen correlation nonce, a string of 1–32 UTF-16 code units or a nonnegative safe integer encoded as a decimal string

Omission sends no nonce, unless the forward source supplies one. Supplying both locations fails locally. For five minutes after saving a message, Fluxer tries to suppress another send through this webhook with the same nonce. This does not guarantee exactly-once delivery

MessageNonce

threadId optional#

Decimal ID of a thread in the webhook's channel, sent as the thread_id query parameter so the message goes to that thread instead of the channel

Fluxer rejects a thread that belongs to another channel, and a forum or media channel needs either this or threadName. It cannot be combined with threadName

string

username optional#

Override the sender name for this message only, using 1–80 UTF-16 code units after U+000C and U+202E removal and surrounding-whitespace trimming

The original string is sent unchanged

string

WebhookMessageReference#

type WebhookMessageReference =
    WebhookReplyReference | WebhookForwardReferencetype WebhookMessageReference =
    | WebhookReplyReference
    | WebhookForwardReference