Add slash commands

Quick start

1. 1

   Create the trigger

   In the desktop app, open your community's Manage Server → Triggers and add one: the command it reacts to, such as /weather, and the URL of your web service.

2. 2

   Receive the message

   When a member sends a message that starts with /weather, mssgs POSTs it to your URL:

   jsonCopy

   {
     "server_guid": "abc12345-...",
     "channel_guid": "def67890-...",
     "trigger_match": "/weather",
     "message": {
       "id": "d01ZZdef6-...",
       "content": "/weather Amsterdam",
       "member_guid": "member-guid",
       "user_guid": "user-guid",
       "group_guids": ["group-guid-1", "group-guid-2"],
       "cms": 1790000000000
     },
     "callback_url": "https://mss.gs/api/v1/trigger-callback/...",
     "stream_url": "https://mss.gs/api/v1/instant/...?token=..."
   }

3. 3

   Answer with JSON

   Answer within 5 seconds with a 2xx status and JSON. It becomes a card in the channel.

   jsonCopy

   {
     "message_container": {
       "color": "blue",
       "title": "Amsterdam",
       "description": "14 °C, light rain until 16:00",
       "fields": [
         { "field": "Wind", "value": "SW 18 km/h" },
         { "field": "Humidity", "value": "82%" }
       ]
     }
   }

   #general

   MA

   maya18:45

   /weather Amsterdam

   

   Message from Weekend Crew

   Amsterdam

   14 °C, light rain until 16:00

   Wind

   SW 18 km/h

   Humidity

   82%

   18:45, maya triggered /weather command

Settings

Each trigger has these settings in Manage Server → Triggers.

What you receive

A POST with a JSON body. The headers include User-Agent: mssgs-webhook/1.0.

Checking who may do what

Compare message.group_guids with the roles you trust, for example to let only moderators run /ban. To keep a command away from everyone else entirely, set its roles in the trigger's settings.

What you answer

Any 2xx status with a JSON body, up to 4 MB. Send at least one of message_container or actions.

Five seconds

mssgs waits 5 seconds for your answer. If you need longer, answer straight away with a loader card and finish through callback_url, which stays valid for 30 minutes.

// Answer within 5 seconds with a loader...
res.json({ message_container: { loader: true, loader_text: 'Looking it up…' } });

// ...then finish in your own time with the callback URL.
await fetch(req.body.callback_url, {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ message_container: { color: 'blue', title: 'Done', description: result } })
});

Private replies

Put member ids in visible_to_member_guids and only they see your answer. Use the member_guid from the request to answer only the person who asked.

{
  "message_container": {
    "color": "green",
    "title": "You're on the list",
    "description": "Only you can see this reply."
  },
  "visible_to_member_guids": ["<message.member_guid from the request>"]
}

A full example

A /weather command in Node.js with Express, answering with a card.

import express from 'express';

const app = express();
app.use(express.json());

app.post('/mssgs/weather', async (req, res) => {
  const city = req.body.message.content.replace('/weather', '').trim() || 'Amsterdam';
  const w = await getWeather(city); // your own lookup

  res.json({
    message_container: {
      color: 'blue',
      title: city,
      description: `${w.temp} °C, ${w.summary}`,
      fields: [
        { field: 'Wind', value: w.wind },
        { field: 'Humidity', value: `${w.humidity}%` }
      ]
    }
  });
});

app.listen(3000);

Limits