API reference

Mirage

Servers, channels, threads, messages, search, emoji, roles, invites, direct messages and live events.

Read the Guide

GET/v1/hooks/messaging/servers/:serverId/icon

A server's icon image (a redirect, cached for 50 minutes); 404 when it has none or uses an emoji. No authentication.

Auth: None.

Path parameters

serverId
Mirage server id (gld_…).

Errors

404No icon.

curl 'https://api.cactive.com.au/v1/hooks/messaging/servers/{serverId}/icon'

Send it from this page with your session or a key.

GET/v1/hooks/messaging/emojis/:emojiId

An emoji's image (a redirect, cached for 50 minutes): a server's (mem_…), or one of Discord's copied across the bridge (dce_<id>). No authentication.

Auth: None.

Path parameters

emojiId
Mirage emoji id (mem_…).

Errors

404Emoji not found.

curl 'https://api.cactive.com.au/v1/hooks/messaging/emojis/{emojiId}'

Send it from this page with your session or a key.

GET/v1/hooks/messaging/stickers/:stickerId

A sticker's image (a redirect): a server's (mst_…), or one of Discord's copied across the bridge (dst_<id>). No authentication.

Auth: None.

Path parameters

stickerId
Mirage sticker id (mst_…; Discord's from the bridge are dst_<id>).

Errors

404Sticker not found.

curl 'https://api.cactive.com.au/v1/hooks/messaging/stickers/{stickerId}'

Send it from this page with your session or a key.

GET/v1/hooks/messaging/gif-preview/:provider/:sig

A GIF picker preview (a redirect to Mirage's copy): u is one of the provider's media links as GET /v1/messaging/gifs signed it; copied into Mirage's files once, so viewers never load the provider's hosts. No authentication.

Auth: None.

Path parameters

provider
GIF provider: klipy or giphy.
sig
Mirage's signature of the preview link (u), from GET /v1/messaging/gifs.

Query parameters

ustring
Default "".

Errors

404Preview not found.

curl 'https://api.cactive.com.au/v1/hooks/messaging/gif-preview/{provider}/{sig}'

Send it from this page with your session or a key.

GET/v1/hooks/messaging/sounds/:soundId

A sound's file (a redirect). No authentication.

Auth: None.

Path parameters

soundId
Mirage soundboard sound id (msd_…).

Errors

404Sound not found.

curl 'https://api.cactive.com.au/v1/hooks/messaging/sounds/{soundId}'

Send it from this page with your session or a key.

GET/v1/hooks/messaging/servers/:serverId/page

A community server's public page (when its owners turned it on): name, icon, banner, description, traits, member count and a lasting invite. No authentication.

Auth: None.

Path parameters

serverId
Mirage server id (gld_…).

curl 'https://api.cactive.com.au/v1/hooks/messaging/servers/{serverId}/page'

Send it from this page with your session or a key.

Response 200

{
  page: {
    serverId: string
    name: string
    icon: null | string
    banner: null | string
    description: null | string
    traits: {
      label: string
      emoji?: string
    }[]
    memberCount: number
    createdAt: number
    inviteUrl: null | string
  }
}

GET/v1/hooks/messaging/invites/:code

An invite's preview without signing in (link previews of the invite page): the server's name, icon, description, member and online counts; 404 when it's expired. Limited per address a minute. No authentication.

Auth: None.

Path parameters

code
Mirage invite code (8 letters and digits); under me/food a household invitation's code (from its link).

curl 'https://api.cactive.com.au/v1/hooks/messaging/invites/{code}'

Send it from this page with your session or a key.

Response 200

{
  code: string
  server: {
    serverId: string
    name: string
    icon: null | string
    description: null | string
    memberCount: number
    onlineCount: number
  }
  channel: {
    channelId: string
    name: null | string
  }
  member?: boolean
}

POST/v1/hooks/messaging/incoming/:webhookId/:token

Posts in the webhook's channel with Discord's payload: content (Markdown; people as <@usr_…>), username (instead of the webhook's name) and embeds (title, url, description, author, fields, footer: shown as a quote). JSON, or a form's payload_json. 204, or the message with ?wait=true. Up to 30 posts a minute by default (platform data); never pings roles or @everyone. The token in the URL is the only credential.

Auth: None.

Path parameters

webhookId
Webhook id (whk_…).
token
A secret from a link: an issue automation rule's incoming-webhook token (shown once when issued), a map's share link, a notification recipient's confirm and unsubscribe link, a Drive public link (/l/<token>), a Vehicles drive's share link, or a Mirage interaction's token (itk_…, sent with the interaction, good for 15 minutes), or the token in the link to a file of a message Mirage sent to Discord, or a Marketing link's sealed token (a tracked click, the open pixel, unsubscribe and the preference centre, a double opt-in confirmation); or a Food recipe's public link (/r/<token>) or a household's calendar feed.

Query parameters

waitstring

curl -X POST 'https://api.cactive.com.au/v1/hooks/messaging/incoming/{webhookId}/{token}'

Send it from this page with your session or a key.

Response 200

{
  message: {
    messageId: string
    channelId: string
    serverId: string
    author: {
      userId: string
      name: string
      bot: "server"
      avatarUrl: null
    } | {
      avatarUrl: null | string
      external?: "discord" | "webhook"
      bot?: "platform" | "server" | "bot"
      userId: string
      name: string
    }
    type: "default" | "join" | "system" | "reply" | "pin" | "follow"
    content: string
    replyTo: null | {
      author: {
        avatarUrl: null | string
        external?: "discord" | "webhook"
        bot?: "platform" | "server" | "bot"
        userId: string
        name: string
      }
      content: string
      messageId: string
    } | {
      deleted: boolean
      messageId: string
    }
    mentions: string[]
    mentionRoles: string[]
    mentionEveryone: boolean
    attachments: {
      url: string
      durationSecs?: null | number
      waveform?: string
      attachmentId: string
      name: string
      mime: string
      size: number
      width: null | number
      height: null | number
    }[]
    reactions: {
      emoji: string
      count: number
      me: boolean
    }[]
    pinned: boolean
    thread: null | {
      threadId: string
      name: string
      messageCount: number
      lastActivityAt: number
      archived: boolean
    }
    poll: null | {
      question: string
      answers: {
        answerId: string
        text: string
        emoji: null | string
        count: number
      }[]
      multiple: boolean
      expiresAt: number
      closed: boolean
      total: number
      mine: string[]
    }
    embeds: {
      url: string
      type: "link" | "video" | "image" | "gifv" | "rich"
      title: null | string
      description: null | string
      siteName: null | string
      author: null | string
      color: null | string
      thumbnail: boolean
      image: null | {
        url: string
        width: null | number
        height: null | number
      }
      video: null | {
        url: string
        width: null | number
        height: null | number
      }
      gif: null | {
        url: string
        width: null | number
        height: null | number
      }
      provider: null | string
      authorUrl: null | string
      authorIcon: null | {
        url: string
        width: null | number
        height: null | number
      }
      thumb: null | {
        url: string
        width: null | number
        height: null | number
      }
      fields: {
        name: string
        value: string
        inline: boolean
      }[]
      footer: null | string
      footerIcon: null | {
        url: string
        width: null | number
        height: null | number
      }
      timestamp: null | number
      source: null | string
    }[]
    editedAt: null | number
    createdAt: number
    nonce: null | string
    interaction: null | {
      interactionId: string
      name: string
      userId: string
      userName: string
      options?: {
        name: string
        value: boolean | string | number
      }[]
      kind?: "command" | "component" | "modal"
      label?: string
    }
    forwarded: null | {
      content: string
      attachments: {
        attachmentId: string
        name: string
        mime: string
        size: number
        width: null | number
        height: null | number
        url: string
      }[]
      embeds: {
        url: string
        type: "link" | "video" | "image" | "gifv" | "rich"
        title: null | string
        description: null | string
        siteName: null | string
        author: null | string
        color: null | string
        thumbnail: boolean
        image: null | {
          url: string
          width: null | number
          height: null | number
        }
        video: null | {
          url: string
          width: null | number
          height: null | number
        }
        gif: null | {
          url: string
          width: null | number
          height: null | number
        }
        provider: null | string
        authorUrl: null | string
        authorIcon: null | {
          url: string
          width: null | number
          height: null | number
        }
        thumb: null | {
          url: string
          width: null | number
          height: null | number
        }
        fields: {
          name: string
          value: string
          inline: boolean
        }[]
        footer: null | string
        footerIcon: null | {
          url: string
          width: null | number
          height: null | number
        }
        timestamp: null | number
        source: null | string
      }[]
      origin: {
        serverId: string
        channelId: string
        messageId: string
        createdAt: number
      }
    }
    published: boolean
    crosspost: null | {
      serverId: string
      channelId: string
      messageId: string
      serverName: string
      channelName: string
      serverIcon: null | string
    }
    display: null | {
      source: "discord" | "webhook"
      name: null | string
      avatarUrl: null | string
      linked: boolean
      externalId: null | string
      externalAuthorId: null | string
    }
    stickers: {
      stickerId: string
      name: string
      format: "gif" | "png" | "webp" | "apng" | "lottie"
    }[]
    components: {
      type: 1
      components: {
        type: 2
        style: 2 | 1 | 3 | 4 | 5
        label?: string
        emoji?: {
          name: string
          id?: string
          animated?: boolean
        }
        customId?: string
        url?: string
        disabled?: boolean
      } | {
        type: 3
        customId: string
        options: object[]
        placeholder?: string
        minValues?: number
        maxValues?: number
        disabled?: boolean
      }[]
    }[]
  }
}

Response 204 with no body

POST/v1/hooks/messaging/incoming/:webhookId/:token/slack

Posts in the webhook's channel with Slack's payload: text (mrkdwn), blocks (header, section, context, divider, rich text) and attachments (as quotes), username. JSON, or a form's payload. Answers ok. Up to 30 posts a minute.

Auth: None.

Path parameters

webhookId
Webhook id (whk_…).
token
A secret from a link: an issue automation rule's incoming-webhook token (shown once when issued), a map's share link, a notification recipient's confirm and unsubscribe link, a Drive public link (/l/<token>), a Vehicles drive's share link, or a Mirage interaction's token (itk_…, sent with the interaction, good for 15 minutes), or the token in the link to a file of a message Mirage sent to Discord, or a Marketing link's sealed token (a tracked click, the open pixel, unsubscribe and the preference centre, a double opt-in confirmation); or a Food recipe's public link (/r/<token>) or a household's calendar feed.

curl -X POST 'https://api.cactive.com.au/v1/hooks/messaging/incoming/{webhookId}/{token}/slack'

Send it from this page with your session or a key.

GET/v1/messaging/me

Your Mirage profile: name, status, custom status and the order of your servers; whether your account shows you are 18 or over (adult), and whether age-restricted channels show in the phone app (ageRestrictedOnPhone).

Auth: A person's token or an API key, as Authorization: Bearer.