வெப்க்குக்கள்து

உள்வரவு Webhook மற்றொரு அமைப்பை ஒரு சேனலுக்கு JSON-ஐ ஒரு ரகசிய URL-க்கு அனுப்பி சேனலில் post செய்ய அனுமதிக்கிறது. வெளியேறு Webhook அதற்கு எதிரான செயலை செய்க: trigger word-உடன் தொடங்கும் அல்லது message menu-இல் மக்கள் தேர்ந்தெடுக்கும் messages-களை உங்கள் URL-க்கு அனுப்பி, நீங்கள் பதிலளிப்பதை post செய்கிறது.

வெப்க்குக்களை மேலாணம் செய்யும் இடம்

வலது மேலே உங்கள் அவட்டரை திறந்து, பின் இணைப்புகள்து என்பதை தேர்ந்தெடுக்கவும். தற்போதைய கம்யூனிட்டியின் இணைப்பு பக்கங்கள் உள்வரவும் வெப்க்குக்கள்து மற்றும் வெளியேறவும் வெப்க்குக்கள்து ஆகியவற்றை பட்டியலிடுகின்றன. ஒவ்வொரு வெப்க்கும் ஒரு கம்யூனிட்டிக்கு உரியது.

இயல்பாக, community admins மற்றும் system admins Webhooks-களை உருவாக்க முடியும். System admin, System Console-இன் permission settings-இல் மற்ற roles-களுக்கு இந்த உரிமையை வழங்க முடியும். System admin, அமைப்பு கன்சோல் › இணைப்புகள் › இணைப்புகள் மேலாண்மை இல் ஒவ்வொரு வகையையும் முடக்க முடியும்: உள்வரவு Webhooks-களை இயக்கு மற்றும் வெளியேறு Webhooks-ஐ இயக்கு இரண்டும் இயல்பாக இயக்கப்பட்டுள்ளன.

A channel with messages from a CI bot and from GitHub, shown as cards with fields, pipeline stages and a button
கார்ட்களாக வரையப்பட்ட இணைப்பு சேய்திகள்: புலங்கள், பைப்லைன் நிலைகள் மற்றும் செயல்பாட்டு பொத்தான்.

உள்வரவும் வெப்க்கை உருவாக்குதல்

  1. இணைப்புகள்து இல், உள்வரவும் வெப்க்குக்கள்து என்பதை தேர்ந்தெடுத்து, பின் உள்வரவும் வெப்க்கை சேர் என்பதை அழுத்தவும்.
  2. ஒரு தலைப்பு மற்றும் ஒரு விளக்கம் ஐ நிரப்பவும்: அவை இணைப்பு பக்கங்களில் மட்டுமே தோன்றும்.
  3. சேய்திகள் இயல்பாக செல்லும் சேனல் ஐ தேர்ந்தெடுக்கவும். தனிப்பட்ட சேனலுக்கு, நீங்கள் அதன் உறுப்பினராக இருக்க வேண்டும்.
  4. அனுப்பிகள் மற்ற இடங்களில் வெளியிட முடியாது என்றால், இந்த சேனலுக்கு பின்தொடரவும் என்பதை குறிக்கவும்.
  5. விருப்பத்திற்கு ஏற்ப, அதன் சேய்திகளுக்கான பயனர் பெயர் மற்றும் சுயவிவரப் படம் URL-ஐ அமைக்கவும் (பார்க்க பெயரும் ஐகனும்).
  6. சேமி என்பதை தேர்ந்தெடுக்கவும். காட்டப்பட்ட URL-ஐ நகலெடுக்கவும்: https://chat.example.com/hooks/<key>.
URL மட்டுமே ரகசியம்: அதை யார் வைத்திருக்கிறார்களோ, அவர்கள் சேனலில் வெளியிட முடியும். அதை பொதுவான ரெபொசிட்டரிகளில் இருந்து தள்ளி வைக்கவும், மற்றும் அது கசிந்தால் வெப்க்கை நீக்கவும்.

API மூலம்: POST /api/v4/hooks/incoming உடன் {"channel_id", "display_name", "description", "username", "icon_url", "channel_locked"}; பதிலின் id என்பது key. கமாண்ட் லைன் மூலம்: amctl webhook create-incoming --channel <channel id> --user <user> --display-name "CI".

உள்வரவும் வெப்க்குக்கு சேய்தி அனுப்பல்

curl -X POST https://chat.example.com/hooks/xgh5ycrx1jf7mbs9w8z4c8e7ho \
  -H 'Content-Type: application/json' \
  -d '{"text": "Deploy of **api 2.4.0** finished :white_check_mark:"}'

சர்வர் 200 உடன் ok உடல்பகுதியுடன் பதிலளிக்கிறது. அது Slack-இன் வெப்க்குக்கள் போல, JSON-ஐ payload புலத்தில் கொண்ட application/x-www-form-urlencoded ஐயும் ஏற்கிறது, எனவே Slack-இன் மூலம் உருவாக்கப்பட்ட கருவிகள் பெரும்பாலும் மாற்றமின்றி வேலை செய்யும்.

புலம்அர்த்தம்
textMarkdown-இல் எழுதப்பட்ட செய்தி. attachments இல்லையெனில் இது அவசியம். சேவையகத்தின் செய்தி வரம்பை விட நீளமான உரை பல செய்திகளாகப் பிரிக்கப்படும்.
channelWebhook-இன் community-இல் உள்ள மற்றொரு சேனல், பெயரால் (ops-alerts அல்லது #ops-alerts), அல்லது Webhook-இன் உரிமையாளருடைய நேரடி செய்திக்காக @username. Webhook அதன் சேனலுக்கு பூட்டப்பட்டிருந்தால் நிராகரிக்கப்படுகிறது. பழைய பெயர் town-square இன்னும் community-இன் இயல்பு சேனலுக்கு (இப்போது general என்று அழைக்கப்படுகிறது) செல்கிறது.
username, icon_url, icon_emojiசேவையகம் மாற்றங்களை அனுமதிக்கும்போது காட்டப்படும் பெயரும் படமும்.
attachmentsஅடிகளாக (கீழே) காட்டப்படும் செய்தி இணைப்புகள்.
propsஅவற்றை படிக்கும் பயன்பாடுகளுக்காக சேய்தியில் சேமிக்கப்படும் கூடுதல் பண்புகள்.
typeஅதை வரைபடும் பயன்பாட்டிற்கான ஒரு தனிப்போஸ்ட் வகை, எடுத்துக்காட்டாக custom_poll. system_ உடன் தொடங்கும் வகைகள் நிராகரிக்கப்படும்.
root_idஅந்த த்ரெட்டில் பதிலளிக்க, ஒரு த்ரெட்டின் முதல் செய்தியின் ID.
priorityசெய்தி முன்னுரிமை, எடுத்துக்காட்டாக {"priority": "urgent"}.
silenttrue எனில், தள்ளல் அறிவிப்புகள் (push notifications) இல்லாமல் செய்தி அனுப்பப்படும்.

Webhook post செய்யும் ஒவ்வொரு message-மும் அதன் பெயருக்கு அருகில் பாட் tag-ஐ கொண்டிருக்கும், உருவாக்குநரின் பெயரில் காட்டப்பட்டாலும், மக்கள் அதை ஒரு உண்மையான மனிதனின் message-இலிருந்து வேறுபடுத்தி அறிய முடியும். Webhook messages-கள் வெளியேறு Webhooks-களை எப்போதும் trigger செய்யாது.

பெயரும் ஐகானமும்

சேவையகம் மாற்றங்களை அனுமதிக்கவில்லை என்றால், வெப்கூக் அதை உருவாக்கிய நபராகவே பதிவிடும். அமைப்பு கன்சோல் › இணைப்புகள் › இணைப்புகள் மேலாண்மை இல் உள்ள இரண்டு அமைப்புகள் (இரண்டும் இயல்பாக அணைக்கப்பட்டவை) இதை மாற்றுகின்றன:

  • பயனர்ப்பெயர்களை மாற்ற இணைப்புகளை இயக்கு (ServiceSettings.EnablePostUsernameOverride): வெப்கூக்கின் பயனர்பெயர்ப் அல்லது கோரிக்கையின் username காட்டப்படும்; இரண்டும் இல்லையெனில் பெயர் webhook ஆகும்.
  • இணைப்புகள் சுயவிவரப் புகைப்பட அடையாளங்களை மாற்ற அனுமதி (ServiceSettings.EnablePostIconOverride): வெப்கூக்கின் சுயவிவரப் படம், அல்லது கோரிக்கையின் icon_url அல்லது icon_emoji காட்டப்படும்.

வெப்கூக்கில் சேமிக்கப்பட்ட மதிப்புக்கு மேல், கோரிக்கையில் உள்ள மதிப்பு முன்னுரிமை பெறும்.

இணைப்புகள்

இணைப்புகள் உரையின் கீழே அமைந்த உள்ளடக்கத்தை சேர்க்கின்றன. அவை Slack-இன் செய்தி இணைப்பு வடிவத்தைப் பின்பற்றுகின்றன:

{
  "text": "Build failed on `main`",
  "attachments": [{
    "fallback": "main #1902 failed",
    "color": "#d24b4e",
    "author_name": "GitHub Actions",
    "author_icon": "https://chat.example.com/static/ci.png",
    "title": "main #1902 failed",
    "title_link": "https://ci.example.com/runs/1902",
    "text": "Commit `0f4d8e2` by Jonas Weber",
    "fields": [
      {"title": "Branch", "value": "zephyr-3.7", "short": true},
      {"title": "Duration", "value": "3m 40s", "short": true}
    ],
    "footer": "Lumen CI",
    "ts": 1760000000
  }]
}
புலம்அர்த்தம்
fallbackஅடிகளைக் காட்ட முடியாத இடங்களுக்கு, எடுத்துக்காட்டாக அறிவிப்புகளுக்கு, எளிய உரை.
colorவண்ணப் பட்டை: ஒரு hex வண்ணம், அல்லது good, warning, danger.
pretextஅடிகளுக்கு மேல் உள்ள உரை.
author_name, author_link, author_iconஒரு சிறிய தலைப்பு வரி.
title, title_linkஅடிகளின் தலைப்பு, விருப்பத்திற்கு ஏற்ப ஒரு இணைப்பு.
textMarkdown-இல் எழுதப்பட்ட அடிகளின் உடல்பகுதி.
fields{"title", "value", "short"} எனும் பட்டியல்; short புலங்கள் பக்கவாட்டில் ஒன்றாக அமையும்.
image_url, thumb_urlகீழே ஒரு பெரிய படம், அல்லது பக்கவாட்டில் ஒரு சிறிய படம்.
footer, footer_icon, tsஒரு காலடி வரி (footer line) மற்றும் நேரம் (Unix வினாடிகள்).
actionsபட்டன்களும் மெனுவ்களும்: இடைவினை செய்திகள் காண்க.

அடிகள்: நிலைகள் மற்றும் வரைபடங்கள்

Antimatter இணைப்புகளுக்கு (attachments) இரண்டு புலங்களை சேர்க்கிறது; இவை இயல்பு இடைமுகத்தால் காட்டப்படுகின்றன:

  • stages: ஒரு பைப்லைனின் (pipeline) படிகள், பில்ல்களாக (pills) — அதிகபட்சம் 20. ஒவ்வொன்றும் {"name", "status"} வடிவத்தில் இருக்கும்; நிலை passed, failed, running, pending, skipped அல்லது canceled ஆக இருக்கும்.
  • chart: சமீபத்திய மதிப்புகளின் சிறிய கோட்டு வரைபடம், {"values": [2 to 200 numbers], "threshold": number, "label": "…"}. எச்சரிக்கையின் எல்லைக்காக, எல்லை மதிப்பு (threshold) துண்டாக் கோடாக வரையப்படுகிறது.
{
  "attachments": [{
    "color": "danger",
    "title": "main #1902 failed",
    "stages": [
      {"name": "build", "status": "failed"},
      {"name": "unit", "status": "skipped"},
      {"name": "publish", "status": "skipped"}
    ]
  }, {
    "color": "warning",
    "title": "API latency above 400 ms",
    "chart": {"values": [210, 230, 260, 390, 450, 470], "threshold": 400, "label": "p95 latency, ms"}
  }]
}

பழைய இடைமுகம் மற்றும் பிற கிளையண்டுகள் இந்த இரண்டு புலங்களையும் புறக்கணிக்கும்; எனவே, அத்தியாவசிய தகவல்களை text அல்லது fields இலும் சேர்த்து வைக்கவும்.

வெளியேறும் வெப்கூகை (outgoing webhook) உருவாக்குதல்

வெளியேறு Webhook community-இன் பொது சேனல்களை கவனித்துக்கொள்கிறது. Message-இன் முதல் சொல் அதன் trigger words-களில் ஒன்றை பொருந்தினால் அல்லது யாராவது message-இன் menu-இல் அதை தேர்ந்தெடுத்தால் (ஒரு message action), அது message-ஐ உங்கள் URL-க்கு அனுப்புகிறது.

  1. இணைப்புகள்து இல் வெளியேறும் வெப்கூக்கள்து ஐத் தேர்ந்தெடுத்து, பின் வெளியேறும் வெப்கூக்கைசு சேர் ஐ அழுத்தவும்.
  2. தலைப்பு மற்றும் விளக்கம் ஐ நிரப்பவும்.
  3. கோரிக்கையின் Content Type ஐத் தேர்ந்தெடுக்கவும்: application/x-www-form-urlencoded அல்லது application/json.
  4. ஒரு சேனல் ஐத் தேர்ந்தெடுத்து, Trigger Words (ஒவ்வொன்றும் ஒரு வரிசையில்) ஐ உள்ளிடவும், அல்லது இரண்டையும் செய்யவும். சேனல் மட்டும் தேர்ந்தெடுத்து டிரிகர் சொற்கள் இல்லையெனில், அந்த சேனலின் அனைத்து செய்திகளும் அனுப்பப்படும். இரண்டும் இருந்தால், செய்தி இரண்டையும் பொருந்த வேண்டும்.
  5. Trigger செய்யும்போது கீழே, முதல் சொல் trigger சொல்லுக்கு துல்லியமாக பொருந்துகிறது, முதல் சொல் trigger சொல்லுடன் தொடங்குகிறது, அல்லது Message menu-இலிருந்து என்பதைத் தேர்ந்தெடுக்கவும். Message menu-இலிருந்து தேர்ந்தெடுத்தால், trigger words மறைந்துவிடும், சேனல் விருப்பத்திற்குரியது (இல்லையெனில், action community-இன் ஒவ்வொரு பொது சேனலிலும் வழங்கப்படும்), மற்றும் தலைப்பு அவசியம்: அது menu-இல் action-இன் பெயர்.
  6. பின்செயல் URL-கள் (ஒவ்வொரு வரிசையிலும் ஒன்று) ஐ உள்ளிடவும். ஒவ்வொரு URL-க்கும் பொருந்தும் அனைத்து செய்திகளும் அனுப்பப்படும்.
  7. விருப்பத்திற்குரிய பதில்களுக்காக பயனர் பெயர் மற்றும் சுயவிவரப் படம் ஐ அமைக்கவும். Message menu-இலிருந்து action-இற்காக, Icon புலம் சுயவிவரப் படம் ஐ மாற்றுகிறது: .png அல்லது .jpg image-இன் URL அல்லது, Antimatter-இன் இயல்பு interface-இல், பதிவேற்றப்பட்ட image. Menu அதை பச்சை நிறத்தில் காட்டுகிறது; இல்லையெனில், action-க்கு ஒரு நடுநெறி icon கிடைக்கும்.
  8. சேமி ஐத் தேர்ந்தெடுத்து, காட்டப்படும் டோக்கனை (token) நகலெடுக்கவும். உங்கள் சேவை, கோரிக்கைகள் உங்கள் சர்வரிலிருந்து வருகின்றன என்பதைச் சரிபார்க்க இதைப் பயன்படுத்தும்.

API மூலம்: POST /api/v4/hooks/outgoing மூலம் {"team_id", "channel_id", "trigger_words", "trigger_when", "callback_urls", "content_type", "display_name"} (trigger_when: 0 என்பது துல்லியமான பொருத்தம், 1 என்பது "தொடங்குகிறது", 2 என்பது "செய்தி மெனுவிலிருந்து"). trigger_when 2 கொண்ட வெப்கூக் (webhook) எந்தவிதமான தூண்டிச் சொற்களையும் (trigger words) ஏற்காது, display_name அவசியம். அதன் ஐகானை (icon) POST /api/v4/hooks/outgoing/{hook_id}/icon மூலம் பதிவேற்றவும் (multipart, புலம் image: PNG, JPEG அல்லது GIF; 128 px PNG ஆக சேமிக்கப்படும்); அதன் icon_url பின்னர் GET /api/v4/hooks/outgoing/{hook_id}/icon ஐக் குறிக்கும்.

உங்கள் சேவை தனிப்பட்ட நெட்வொர்க்கில் (private network) இருந்தால், அமைப்பு நிர்வாகி (system admin) அதன் முகவரியை அந்நம்பிக்கையான உள்நூல் இணைப்புகளை அனுமதிக்க (ServiceSettings.AllowedUntrustedInternalConnections) இல் அனுமதிக்க வேண்டும். இல்லையெனில், சர்வர் தனிப்பட்ட முகவரிகளை அழைக்காது.

வெளியேறும் கோரிக்கை (outgoing request)

Antimatter, Content Type-க்கு ஏற்ப JSON அல்லது form-encoded வடிவில், பின்வரும் புலங்களுடன் ஒரு POST-ஐ அனுப்புகிறது:

{
  "token": "6kd1ofo5ojr5zgu5ipfipybgnc",
  "team_id": "…",
  "team_domain": "lumen-labs",
  "channel_id": "…",
  "channel_name": "ops-alerts",
  "timestamp": 1760010000000,
  "user_id": "…",
  "user_name": "priya",
  "post_id": "…",
  "text": "deploy api 2.4.0",
  "trigger_word": "deploy",
  "file_ids": ""
}

எதையும் செய்யும் முன், token ஐ வெப்கூகின் டோக்கனுடன் ஒப்பிடுங்கள். பார்ம்-என்கோடெட் பதிப்பில், timestamp மில்லிசெகண்ட்களாக இல்லாமல் வினாடிகளாக இருக்கும். சேவையகம், Integration request timeout அனுமதிக்கும் வரை (இயல்பாக 30 வினாடிகள், ServiceSettings.OutgoingIntegrationRequestsTimeout) உங்கள் பதிலுக்காக காத்திருக்கும்.

வெளியேறும் வெப்கூகிற்கு பதில் அனுப்புதல்

பதில் அனுப்ப, JSON மூலம் பதிலளிக்கவும். எதுவும் அனுப்ப விரும்பவில்லை என்றால், காலியான உடலுடன் (empty body) பதிலளிக்கவும்.

{
  "text": "Deploying **api 2.4.0** to staging…",
  "response_type": "comment",
  "username": "deploy-bot",
  "icon_url": "https://chat.example.com/static/deploy.png"
}
  • text மற்றும் attachments: பதில். இவற்றில் எதுவும் இல்லையெனில், எதுவும் பதிவாகாது.
  • response_type: comment என்பது தூண்டிய செய்தியின் த்ரெட்டில் பதிலைப் பதிவு செய்யும்; மற்றவற்றில் அது சேனலுக்குச் செல்லும்.
  • username, icon_url: சேவையகம் மாற்றங்களை அனுமதித்தால் காட்டப்படும்; இல்லையெனில் வெப்கூகின் சொந்த மதிப்புகள் பயன்படுத்தப்படும்.
  • props, type, priority: வரும் வெப்கூகுகளுக்குப் போலவே.

பதில், மாற்றப்பட்ட பெயர் இருந்தால் அந்தப் பெயரின் கீழ், வெப்கூகின் உருவாக்குநராகப் பதிவாகும். விரைவான பதில்களுக்கு மேல் நீளமான உள்ளடக்கங்களுக்கு, உடனடியாக பதிலளிக்கவும், பின்னர் வரும் வெப்கூகை அல்லது API மூலம் பதிவு செய்யவும்.

செய்தி செயல்கள்

ஒரு செயல்பாடு (action) என்பது Trigger செய்யும்போது செய்தி மெனுவிலிருந்து என அமைக்கப்பட்ட ஒரு வெளியேறும் வெப்கூக் (outgoing webhook) ஆகும். இது வெளியிடப்பட்ட செய்திகளில் எப்போதும் செயல்படாது. மாறாக, பயனர்கள் அதை ஒரு செய்தியின் மெனுவில் காண்கிறார்கள்: செய்தி செயல்கள் (⋯) › மேலும் செயல்கள், இணைப்புகள் தலைப்பின் கீழ், அதன் ஐகானுடன். பழைய இடைமுகம் (classic interface) செயல்பாடுகளைக் காட்டாது. அதைத் தேர்ந்தெடுப்பது அந்த ஒரு செய்தியை மீள் அழைப்பு முகவரிகளுக்கு (callback URLs) அனுப்புகிறது, மேலும் ஒரு குறுகிய அறிவிப்பு அனுப்பப்பட்டது (Sent to) என்று செயல்பாட்டின் பெயரைக் காட்டுகிறது, அல்லது உங்கள் ephemeral_text ஐக் காட்டுகிறது.

  • எங்கே காட்டப்படும்: வெப்கூக்கின் சேனலில், அல்லது சேனல் இல்லையெனில், அதன் சமூகத்தின் (community) அனைத்து பொது சேனல்களிலும். பொது சேனல்களில் மட்டுமே செயல்பாடுகள் இருக்கும்.
  • விரும்பினரின் (Guests) க்கு, அவர்கள் இருக்கும் சேனலுடன் இணைக்கப்பட்ட செயல்பாடுகள் மட்டுமே கிடைக்கும், சமூகம் முழுவதும் செயல்படும் செயல்பாடுகள் கிடைக்காது.
  • காப்பகப்படுத்தப்பட்ட மற்றும் படிக்க மட்டும் சேனல்கள்: செய்தியை இன்னும் அனுப்ப முடியும். ஒரு சேனலை காப்பகப்படுத்துவது அதனுடன் இணைக்கப்பட்ட வெப்கூக்குகளை நீக்குகிறது, எனவே ஒரு காப்பகப்படுத்தப்பட்ட சேனல் சமூகம் முழுவதும் செயல்படும் செயல்பாடுகளை மட்டுமே வைத்திருக்கும். அந்த நபர் அங்கு வெளியிட முடியாத பதில், அவருக்கு மட்டும் காட்டப்படும்.
  • விகித வரம்பு (Rate limit): ஒவ்வொரு நபரும் ஒரு நிமிடத்திற்கு 10 செயல்பாடுகளை இயக்க முடியும், 5 செயல்பாடுகளின் உச்சத்திற்குப் பிறகு. அதற்கு மேல், சர்வர் 429 பதிலைத் தரும்.
  • தனியார் நெட்வொர்க்குகள்: மற்ற வெளியேறும் வெப்கூக்குகளுக்குப் போல, உள் முகவரிகள் அந்நம்பிக்கையான உள்ளூர் இணைப்புகளை அனுமதிக்க இல் அனுமதிக்கப்பட வேண்டும்.

கோரிக்கை (Request)

பலூட் (payload) வெப்கூக்கின் உள்ளடக்க வகை (content type) கூறுவது போல JSON அல்லது படிவ-குறியீடு (form-encoded) ஆக அனுப்பப்படும்:

{
  "token": "6kd1ofo5ojr5zgu5ipfipybgnc",
  "trigger": "message_action",
  "team_id": "…",
  "team_domain": "lumen-labs",
  "channel_id": "…",
  "channel_name": "ops-alerts",
  "timestamp": 1760010000000,
  "user_id": "…",
  "user_name": "priya",
  "post_id": "…",
  "post_root_id": "",
  "post_create_at": 1760009000000,
  "post_user_id": "…",
  "post_user_name": "jonas",
  "permalink": "https://chat.example.com/lumen-labs/pl/…",
  "text": "The staging database is full again",
  "files": [{"id": "…", "name": "df.txt", "link": "https://chat.example.com/api/v4/files/…"}],
  "priority": "",
  "requested_ack": false,
  "burn_on_read": false
}
  • user_id மற்றும் user_name என்பவை செயல்பாட்டைத் தேர்ந்தெடுத்த நபர்; post_user_id மற்றும் post_user_name என்பவை செய்தியின் ஆசிரியர்.
  • அந்த செய்தி மட்டுமே அனுப்பப்படும், அதன் த்ரெட்டின் (thread) மீதியை எப்போதும் அனுப்பாது.
  • files என்பது செயல்பாட்டைத் தேர்ந்தெடுத்த நபர் அவற்றைப் பதிவிறக்க (download) செய்ய அனுமதிக்கப்பட்டால் மட்டுமே செய்தியின் கோப்புகளைப் பட்டியலிடுகிறது. ஒரு link ஐப் பதிவிறக்குவதற்கு, API-யின் எந்தவொரு கோப்பைப் போல, ஒரு அமர்வு (session) அல்லது டோக்கன் (token) தேவை.
  • படிக்கும்போது எரிந்துபோகும் செய்தி, அதன் உரை மற்றும் கோப்புகளுடன் அனுப்பப்படாமல், burn_on_read மதிப்பு true என அமைக்கப்பட்டிருக்கும்.
  • படிவ-குறியீட்டில் (form-encoded), கோப்புகள் ஒரே வரிசையில் மீண்டும் மீண்டும் file_id, file_name மற்றும் file_link புலங்களாக வருகின்றன.

பதில்

வெளியேறும் வெப்கூக்கிற்கு (outgoing webhook) அனுப்பப்படும் எந்தவொரு பதிலையும் போல (இதனைப் பார்க்க வெளியேறும் வெப்கூக்கிற்கு பதில் அனுப்பல்): text அல்லது attachments சேனலில் பதிலைப் பதிவு செய்யும்; "response_type": "comment" அதனை செய்தியின் த்ரெட்டில் பதிவு செய்யும். ephemeral_text மூலமும் பதில் அனுப்பலாம் (300 எழுத்துக்களுக்குள்): இது செயலைத் தேர்ந்தெடுத்த நபருக்கு மட்டும், அறிவிப்பில் (notice) காட்டப்படும். காலியான உடல் (body) எதுவும் பதிவு செய்யாது.

{"ephemeral_text": "Ticket OPS-412 created"}

API மூலம்

  • GET /api/v4/channels/{channel_id}/message_actions: ஒரு சேனலில் நீங்கள் தேர்ந்தெடுக்கக்கூடிய செயல்கள், id, display_name, description மற்றும் icon_url உடன். டோக்கன்கள் அல்லது கால்பேக் URL-கள் திரும்பிவரவில்லை.
  • POST /api/v4/posts/{post_id}/message_actions/{hook_id}: நீங்கள் படிக்கக்கூடிய செய்தியில் ஒரு செயலை இயக்குகிறது. இது {"ephemeral_text"} என பதில் அளிக்கிறது.

வெப்கூகம் வேலை செய்யாதபோது

  • 501 from the hook URL: சேவையகத்தில் வரும் வெப்கூகுகள் முடக்கப்பட்டுள்ளன.
  • 400 "Failed to decode the payload…": JSON தவறானது, அல்லது பார்ம் புலம் payload என பெயரிடப்படவில்லை. "No text specified." என்பது கோரிக்கையில் text அல்லது attachments இல்லை என்பதைக் குறிக்கிறது.
  • 403: வெப்கூகம் மற்றொரு சேனலுக்கு முடக்கப்பட்டுள்ளது, அல்லது அதன் உரிமையாளர் சேனலை இனிமேல் படிக்க முடியாது.
  • வெளியேறும் வெப்கூக் ஒருபோதும் இயங்காது: சேனல் தனியானது, தூண்டி முதல் சொல்லாக இல்லை, செய்தி ஒரு வெப்கூக்கிலிருந்து வந்தது, அல்லது வெப்கூக் செய்தி மெனுவிலிருந்து (From the message menu) தூண்டப்படるように அமைக்கப்பட்டுள்ளது.
  • செய்தி செயல் மெனுவில் இல்லை: சேனல் தனியானது, செயல் வேறு சேனலுடன் இணைக்கப்பட்டுள்ளது, நபர் விருந்தினர் (guest) ஆக இருந்து செயலுக்கு சேனல் இல்லை, அல்லது வெளியேறும் வெப்கூக்கள் முடக்கப்பட்டுள்ளன.
  • செய்தி செயலை இயக்கும்போது 404: செயல் இல்லை, அல்லது அந்த நபருக்கு அந்த செய்தியின் சேனலை அது மூடவில்லை. 429: நபர் ஒரு நிமிடத்தில் 10-க்கும் மேற்பட்ட செயல்களை இயக்கினார். 502: எந்த கால்பேக் URL-யும் அடையப்படவில்லை (காரணம் பதிவு/லாக்கில் உள்ளது).
  • Logs: Enable Webhook Debugging இயக்கப்பட்டால் (LogSettings.EnableWebhookDebugging), மற்றும் லாக் நிலை DEBUG ஆக இருந்தால், சேவையகம் தோல்வியடைந்த வரும் கோரிக்கைகளின் லோடுகளைப் பதிவு செய்யும். தோல்வியடைந்த வெளியேறும் அழைப்புகள் Outgoing Webhook POST failed எனப் பதிவு செய்யப்படும்.