Pievieno pogas
Novieto pogas zem jebkuras kartītes. Poga atver saiti, maina kartīti visiem tajā brīdī, kad kāds tai pieskaras, vai paziņo tavam servisam, ka tā nospiesta.
Ko tu vari darīt
- Atver saitiNosūti cilvēkus uz lapu, paneli vai pull request.
- Maini kartīti vienā pieskārienāRediģē to, noņem, reaģē vai atbildi tieši ar nospiešanu, bez sava servera.
- Uzzini par katru nospiešanuTavs serviss reāllaikā uzzina, kurš ko nospieda.
- Palaid komanduPoga var iedarbināt kādu no kopienas slīpsvītras komandām, ar datiem.
Lietotnē
Kāds zvana: parādās kartīte
Pieskāriens pogai Atvērt vārtus: kartīte mainās visiem
Pašai izmaiņai serveris nav vajadzīgs: soļi tiek glabāti kopā ar ziņu. Tavs vārtu kontrolieris uzzina par nospiešanu un atver vārtus.
Ātrais sākums
Pievieno actions sarakstu
Pogas tiek liktas
actionsblakus kartītei: webhook ierakstā, atbildē uz komandu vai atjauninājumā.json{ "message_container": { "color": "yellow", "title": "Deploy v2.1 to production?", "description": "Requested by maya." }, "actions": [ { "type": "url:https://ci.example.com/deploys/218", "text": "View changes", "color": "blue" } ] }deploysIzvēlies, ko dara nospiešana
Saite, kartītes izmaiņa vai tava servisa izsaukums. Visi trīs veidi aprakstīti zemāk.
Trīs pogu veidi
To, ko dara nospiešana, nosaka type.
| Tips | Ko dara nospiešana | Vai sasniedz tevi |
|---|---|---|
url:{url} | Atver saiti. | Nē |
webhook_action | Izpilda kopā ar to saglabātos soļus visiem kanālā. | Jā, ziņas stream_url |
trigger:{guid} | Iedarbina kādu no kopienas trigeriem ar pogas payload. | Jā, kā jaunu pieprasījumu uz šī trigera URL |
Maini kartīti vienā pieskārienā
webhook_action pogai laukā triggers ir soļu saraksts. Pēc nospiešanas tie secīgi tiek izpildīti mssgs serverī, un rezultātu redz visi kanālā.
| Solis | Ko tas dara visiem | Lauki |
|---|---|---|
update_message | Aizstāj kartīti un tās pogas. Nosūti "actions": [], lai pogas noņemtu. | message_container, actions, content |
remove_message | Dzēš ziņu. | Nav |
add_reaction | Pievieno reakciju tā dalībnieka vārdā, kurš nospieda. | emoji |
add_reply | Publicē atbildi tā dalībnieka vārdā, kurš nospieda. | content |
{
"message_container": { "color": "yellow", "title": "Front door", "description": "Someone rang the bell." },
"actions": [
{
"type": "webhook_action",
"id": "open_gate",
"text": "Open gate",
"color": "green",
"payload": { "door": "front" },
"triggers": [
{
"action": "update_message",
"message_container": { "color": "blue", "title": "Front door", "description": "Opening…" },
"actions": []
},
{ "action": "add_reaction", "emoji": ":white_check_mark:" }
]
}
]
}Uztver nospiešanu
Ziņa ar pogām atgriežas no webhook ar stream_url. Turi to atvērtu, un katra nospiešana pienāks kā action tipa notikums ar pogas id, saglabāto pogu un tās payload, kā arī ziņu par to, kurš to nospieda:
data: {"type": "action", "message_id": "...", "action_id": "open_gate", "action": {"id": "open_gate", "payload": {"door": "front"}, ...}, "member_guid": "member-guid", "member": {...}, "ts": 1790000000000}Paveic īsto darbu, piemēram, atver vārtus, un pēc tam iestati kartītes galīgo stāvokli caur callback_url. Kā darbojas plūsma un callback, skaidrots lapā atjauninājumi reāllaikā.
Palaid komandu ar pogu
Poga trigger:{guid} iedarbina kādu no tavas kopienas trigeriem, it kā kāds būtu ierakstījis komandu, un nodod pogas payload. Trigeris saņem:
{
"actions": [
{
"type": "trigger:5f2c9a1e-trigger-guid",
"text": "Check status",
"color": "blue",
"payload": { "order_id": "12345" }
}
]
}{
"trigger_match": "/status",
"message": {
"content": "[Action Triggered]",
"member_guid": "member-guid",
"is_action_button": true,
"action_payload": { "order_id": "12345" }
},
"callback_url": "https://mss.gs/api/v1/trigger-callback/...",
"stream_url": "https://mss.gs/api/v1/instant/...?token=..."
}payload.Lauki
| Lauks | Tips | Ko tas dara |
|---|---|---|
type | string | url:{url}, webhook_action vai trigger:{guid}. Obligāts. |
text | string | Uzraksts uz pogas. Obligāts; der arī label. |
color | string | Pogas krāsa, skati zemāk. |
id | string | Ar webhook_action: kura poga tika nospiesta. Unikāls ziņas ietvaros. |
payload | object | Tavi dati, ko saņem atpakaļ pēc nospiešanas. |
triggers | array | Ar webhook_action: izpildāmie soļi. |
disabled | boolean | Rāda pogu pelēku, un nospiešanas tiek noraidītas. |
Krāsas
green, blue un purple zīmē pilnu, primāro pogu. red, orange un yellow zīmē sekundāro: lieto tās pogām „Noraidīt“, „Atcelt“ un citām izvēlēm, kas prasa piesardzību.
Kļūdas
Kad publicē ziņu ar pogām, mssgs vispirms tās pārbauda:
| Kods | Nozīme |
|---|---|
INVALID_ACTIONS_FORMAT | actions nav objektu saraksts. |
INVALID_ACTION_MISSING_FIELDS | Pogai nav type vai text. |
DUPLICATE_ACTION_ID | Divām pogām ir vienāds id. |
INVALID_TRIGGERS_FORMAT | triggers nav soļu saraksts. |
INVALID_TRIGGER_MISSING_ACTION | Solim nav action. |
INVALID_TRIGGER_ACTION_NOT_ALLOWED | Solis, kas nav neviens no četriem iepriekš minētajiem. |
Kad kāds nospiež
| Kods | Nozīme |
|---|---|
MESSAGE_NOT_FOUND | Ziņa pa to laiku ir izdzēsta. |
ACTION_NOT_FOUND | Ziņā nav pogas ar šādu id. |
ACTION_DISABLED | Poga ir atspējota. |
TRIGGER_NOT_FOUND, TRIGGER_NOT_ACTIVE | Trigeris, uz kuru norāda poga, vairs nepastāv vai ir izslēgts. |
TRIGGER_NOT_ALLOWED | Dalībniekam nav lomas, kas drīkst izmantot šo trigeri. |
Nāc no vecās dokumentācijas?
button un soļiem ws:send, local:update_message un local:remove_message, nosacījumi previous:success un expire_in_seconds ārējiem sūtītājiem vairs nedarbojas. Lieto webhook_action ar iepriekš aprakstītajiem soļiem: tie sasniedz visus, ne tikai to, kurš nospieda.