Kapsule Orbit Webhooks

Webhooks e tukituki ana i tētahi HTTP POST tohu ki tētahi URL e āhei ai koe ki te tohu tonutanga kē, ia wā ka rerekē te āhuatanga o tētahi tūmahi tūmitanga, kia rongo ai tō tīma mō tētahi hanga kāore i tutuki i roto i te horopaki e tirotiro nuitia e rātou, kāore i te kōrero mai i tētahi kaihoko.

Te Wāhi o Webhooks

Whakatupu Kapsule Orbit, pīwhiri i te kaupapa, ka tīpako Webhooks i raro i te rōpū Configure i te kuwea kaupapa. Ko te īhuatanga o te whārangi ko Webhooks ā, e whakaahuatia ana ia e tae mai ana kia whakatangi HTTP POST mō te wā ka rerekē te āhuatanga o ngā tūmahi tūmitanga, ā, ka whakamahia ana e Slack, Discord me te JSON noa iho.

Te Tāpiri i tētahi Webhook

1. I roto i te kāri Add a webhook, hoatu tētahi Label. He mea ōrite tonu ki te wāhi e tukitukia ana ki reira.
2. Whakatakoto i te URL. Me tīmata https://.
3. I raro i Trigger on, tīkina ngā kaupapa e hiahia ai koe.
4. Pīwhiri Add webhook.

Ko te tohu orokohanga tohu e whakaatu kē, i muri tata ake i te waihanga, me tētahi whakatūpato e kī ana ka kore e whakaatu hou. Tuhia atu anō koe i mua i tō hikenga atu.

Ka taea e tētahi kaupapa te pupuri i te tekau webhooks. Ko te tekau mā tahi webhook e tāpiri ana ka kore, ā, me tētahi karere e ingoa ana i te rohe.

Ngā Kaupapa Rima

Tohu whai whakaaro. Ko te manako i ngā kaupapa e rima katoa i roto i tētahi kaupapa nui ka huri i tētahi horopaki whakatupato whaitake ki te haruru ka pēhia e te katoa. Mo te nuinga o ngā tīma, ko Failed anake te tīmatanga tika, me Succeeded ka tāpirihia anō kē mēnā e whai whakaaro nuitia ai te whakatupato tūmitanga, pēnā me tētahi horopaki mahi.

Slack me Discord

Mēnā ko te URL he Slack puta mai webhook, he Discord webhook rānei, ka tīpakohia e Kapsule Orbit mai i te URL, ā, ka tukitukia he karere āhua noa, kāore i te JSON kore. E kī ana te whārangi i raro i te wāhi URL: ko ngā URL Slack me Discord ka tīpakohia.

Ko te karere āhua e mau ana i te ingoa kaupapa, te kaupapa, te peka, te tuhinga haumako poto, te wā hanga, te URL kua whakarewaina, me te kupu hē mēnā i te hē tētahi. Ko te tae e whai te kaupapa, nō reira ko tētahi kāri whero i te horopaki e tohu ana i te hē, kāore ko te āta pānui.

Kahore he atu mea e hiahia. Waihanga te puta mai webhook i Slack, Discord rānei, whakatakoto i te URL ki konei, tīpako i ā koe kaupapa, ā, kua oti.

Ngā Payload JSON Noa Iho

Ko anumanu URL atu ka whakatangi i tētahi puku JSON. Ko ngā āhuatanga:

Whakamahia deliveryId kia mahi tō ira paetae i te āhuatanga tahi anake. Mēnā e honohono hou koe i tētahi tukituki, he whakatikanga kupenga rānei ka puta he rua, ka āwhina te id kia matau koe kua tauwhiro e koe.

Te Tohu Whakatūturu

Ka mau i ia tukituki te toru pokapū:

• X-Orbit-Signature-256, he HMAC-SHA256 o te tino puku tono e whakamahi ana i tō tohu orokohanga, he āhuatanga sha256= ā, ko te whakaemi whara.
• X-Orbit-Event, te ingoa kaupapa.
• X-Orbit-Delivery, te id tukituki.

Tūturu i te tohu i mua i tō mahi atu i te payload. Tatau i te HMAC ōrite ki runga i ngā pūtakeroa tino puku, ā, whakataurite e te whakataurite wā āhuatanga, kāore i te ōrite kupu.

const expected = 'sha256=' + crypto
  .createHmac('sha256', process.env.ORBIT_WEBHOOK_SECRET)
  .update(rawBody)
  .digest('hex');

if (!crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(received))) {
  return res.status(401).end();
}

Te Whāia i tētahi Webhook

I ia rarangi webhook he Send test delivery. Ka ara i tētahi tukituki pono ki tō ira paetae ata tata, ā, e whakaatu ana i te HTTP waehere i tukua, he mea rānei i te hapa o te whakamārama.

Whakamahia i muri tata ake i te tāpiri i tētahi webhook, i mua i tō whakawhirinaki. Ko tētahi ture āpirana, he huarahi rānei ka whakamahi GET anake, he mea nui ake te rapu i konei, kāore i te wā o te tūkino.

Te Hītori Tukituki

I ia rarangi ka mau i tētahi sparkbar o ngā rā e whitu o mua me te taukake tukituki, te paerewa whakatupato me te piki tonutanga, ā, ko te wā i whakatutuki ai me tōna hua.

Whakatupu Show delivery history mō ngā tukituki takitahi: te kaupapa, te waehere urupare, te piki, me te kupu hē me te hē tēnā. Ka āwhina ia tukituki kia tukitukia hou e Retry delivery, e whakaatu ana i te waehere i tukua.

Ko ngā tukituki ka tatū i muri i te tekau mā rua hēkona. Mēnā e mahi ngaronga tō ira paetae, whakamōhio me te 200 tuatahi, ā, mahi i muri, kāore i te tōtōnu te hononga.

Te Tīwhara i te Tohu

Pīwhiri Rotate secret. Ko te tohu hou e whakaatu kē, ā, e kī ana te araara he nui ake kua mutu te tohu tawhito.

Ko te tikanga he iti rawa te waahi kei te tohu kē ngā tukituki, kāore e mōhiotia e tō ira paetae. Whakapaetai mo ēnei: tīwharahia i tētahi wā kē noa iho, ā, whakahou i tō ira paetae hei mahi tino whai ake.

Tīwhara mēnā kua whakamarama te tangata i te uru ki te tohu, rānei mēnā kua whakatakoto koe ki tētahi horopaki whakatūturu, tahi rānei rānei.

Te Kāpae me te Muku

Disable webhook ka tū te tukituki, ā, kia ture te whiringa me te hītori, ā, ka whakaatu te rarangi i tētahi Disabled tohu. Ko te tohu tika me te tatū i ngā whakatupato, heoi, i te wā o te rereketanga whakapaetai ka puta he haruru nui.

Delete webhook ka mukua atu te mea. Whakamahia te kāpae ki te kore e whakatokeke.

Ētahi Atu Huarahi ki te Whakarongo

Ko Webhooks te whiringa whanui. Kei roto i ngā waihanga māmā e rua Settings:

• Deploy email notifications, me ngā whiringa e toru: te tūmahi tūmitanga katoa, ngā hapa anake, rānei kāore.
• Notification channels, e tukituki ana ki tētahi webhook URL i te hua tūmitanga, i te hapa rānei, i te haurona hanga me te haurona pūtea, me tō rātou ake hītori tukituki me te pōtae whāia.

Tirohia Orbit Project Settings mō te rua.

Te Whakatika i ngā Raru

Ko ngā tukituki e whakaatu ana kua hapa me tētahi waehere HTTP. I whakahoki te ira paetae i tētahi hē. Ko te waehere e kōrero ana ko ēhea: ko te 404 e tohu ana te ara kau, ko te 401, 403 rānei he nuinga te whakatūturu tohu tōu e kāpae ana, ā, ko te 500 e tohu ana i tō kaiwhakahaere i te whapa.

Ko ngā tukituki e hapa ana me te tatū. I te mahue i te tekau mā rua hēkona tō ira paetae. Whakahoki 200 ata tata, ā, mahi i te muri.

Kaore he mea e tukitukia. Tirotiro kei te āhei te webhook, kua tīkina te kaupapa i hiahia ai koe. Ko te hanga i kore te rauponga ka kore e ara i te kaupapa rauponga.

Ko te tohu ka kore e whakatūturu. Ko te nuinga ake ko te raru puku-tino e whakaahuatia ana i runga ake nei. Whakataka te pūtakeroa tika e tatau ana koe, ā, whakataurite i tō roa me te pokapū Content-Length.

Ko tētahi URL Slack e tukitukia ana kia raw JSON. Ko ngā Slack puta mai webhook kei raro i hooks.slack.com. Ko tētahi URL Slack rerekē ka kore e tīpakohia.

Te Wāhi Ki Haere Atu

• Triggering Deployments Via Deploy Hooks mō te ahunga puta mai.
• Orbit Project Settings mō ngā whakatupato īmēra me ngā horopaki whakatupato.
• Orbit Status Page ki te kōrero ki a ō kaihoko, kāore i tō tīma anake.