Please see the latest documentation here: https://dev.collab.land/docs/upstream-integrations/build-a-custom-action
Collab.Land Actions is a simple REST API endpoint for building custom actions for Discord interactions.
This document outlines the process of creating custom Collab.Land Actions via the /metadata
and /interactions
endpoints.
/metadata
This API should return your mini-apps metadata. Collab.Land will call the endpoint to fetch the details of your mini-app for audit and operational purposes. It should return a metadata
result containing your apps manifest
, supportedInteractions
and applicationCommands
in the format outlined below:
interface Metadata {
// Manifest for defining mini-app metadata
manifest: MiniAppManifest;
// A list of all the supported interactions on your app
supportedInteractions: {
type: InteractionType;
names: ["hello-action"];
};
// All the application commands that will be used
applicationCommands: ApplicationCommand;
}
The manifest
****is a model that defines the details of the mini-app. It has the following structure:
interface MiniAppManifest {
// Unique Id for Mini App
appId: string;
// The developer for the Mini App
developer: string;
// Name for the Mini App
name: string;
// Short Name for the Mini App
shortName: string;
// Release date
releasedDate?: number;
// Version of miniapp
version?:{name:’1.0.0’};
// Keywords for the search
keywords?: string[];
// Tags
tags?: string[];
// Website url of the mini app docs or homepage
website?: string;
// Short Description of the mini app which will reflect on listing page
shortDescription?: string;
// This can be markdown or docs for what Mini App can do and what is it for?
description?: string;
platforms?: [‘discord’];
}