Ang webhook ay isang HTTP request na ipinapadala ng isang serbisyo sa URL na iyong nirehistro tuwing may partikular na kaganapan na nangyayari. Pinapayagan nito ang iyong sistema na tumanggap ng data habang nangyayari ito, sa halip na paulit-ulit na mag-poll ng API upang tingnan kung may bago. Sa isang data pipeline, nangangahulugan ito na ang isang trabaho ay maaaring tumugon sa isang kaganapan sa sandaling ito ay iniulat ng pinagmulan.

Halimbawa, ang payment platform na Stripe ay nagpapadala ng mga webhook events sa iyong endpoint sa pamamagitan ng HTTPS bilang isang JSON payload. Dapat tanggapin ng iyong endpoint ang mga POST request at iproseso ang event data na natanggap nito.

Paano Gumagana ang Webhook Delivery

Ipinapakita ng dokumentasyon ng Stripe ang mga pangunahing mekanika:

  • Rehistrasyon: Nagre-rehistro ka ng isang endpoint URL. Sa live mode, nangangailangan ang Stripe ng isang pampublikong ma-access na HTTPS URL.
  • Mabilis na pagkilala: Dapat mabilis na magbalik ang endpoint ng 2xx status code, bago ang anumang kumplikadong lohika na maaaring magdulot ng timeout.
  • Retries: Kung mabigo ang delivery, nagre-retry ang Stripe ng hanggang tatlong araw na may exponential backoff sa live mode.
  • Pagkakasunod-sunod: Hindi ginagarantiyahan ng Stripe na darating ang mga kaganapan sa pagkakasunod-sunod na kanilang nilikha.

Pagsisiguro ng Webhook Endpoint

  • Tiyakin ang mga signature: Nilagdaan ng Stripe ang bawat kaganapan gamit ang HMAC na gumagamit ng SHA-256 at inilalagay ang signature sa Stripe-Signature header.
  • Hadlangan ang mga replay: Kasama sa nilagdaang payload ang isang timestamp, kaya maaari mong tanggihan ang mga kaganapan na masyadong luma na.
  • Hawakan ang mga duplicate: Maaaring makatanggap ang isang endpoint ng parehong kaganapan nang higit sa isang beses. I-log ang mga processed event IDs at laktawan ang mga ulit.
  • Allowlist ang mga sender: Nagpapadala ang Stripe ng mga webhook mula sa isang nakapublikong listahan ng mga IP address na maaari mong limitahan sa iyong firewall.

Karaniwang Paggamit ng Webhook

  • Code at deployment: Nagpapadala ang GitHub ng isang HTTP POST payload sa iyong URL para sa mga kaganapan ng repository na iyong sinubscribe. Ang mga dokumento nito ay naglilista ng mga gamit tulad ng pagsisimula ng CI builds, pag-update ng isang external issue tracker, pag-refresh ng backup mirror at pag-deploy sa isang production server.
  • Mga Bayad: Pinapayagan ng mga webhook ng Stripe na tumugon ka sa mga asynchronous na kaganapan, tulad ng pagkumpirma ng isang bangko sa isang bayad, pagtutol ng isang customer sa isang charge o tagumpay ng isang recurring payment.
  • Mag-subscribe lamang sa kailangan mo: Pinapayuhan ng Stripe na huwag makinig sa labis o lahat ng mga kaganapan dahil naglalagay ito ng labis na strain sa iyong server.

Kaugnay na Mga Termino