Ireretiro ang lowpoly sa Oct 30, 2026. Lumipat ng modelo bago ang mga petsang ito para maiwasan ang mga error sa request.

Webhooks

Ang Webhooks ay nagbibigay-daan sa iyo na makatanggap ng real-time updates mula sa Meshy kapag natapos na o nagbago ang status ng iyong mga API task. Kapag na-configure na, magpapadala ang Meshy ng event payloads sa json format papunta sa mga URL na itinakda mo.

Bakit Gumawa ng Webhooks

Maraming benepisyo ang paggamit ng webhooks, lalo na pagdating sa awtomatikong pagsuri sa status ng API task. Mas kaunti ang effort at gastos na kailangan ng webhooks kumpara sa patuloy na pag-poll sa API para makakuha ng mga update sa status ng task. Nagbibigay din ang webhooks ng malapit sa real-time na updates at sa huli ay mas scalable kumpara sa API polling. Nakakatulong din ito para mas mahusay mong mapangasiwaan ang iyong rate limits, lalo na kung patuloy kang nag-po-poll.

Setup & Configuration

Para i-enable ang webhooks, buksan ang Webhooks page sa Developer Platform at i-click ang button na "Create Webhook". Ibigay ang https URL na gusto mong gamitin para makatanggap ng webhooks at i-enable ang webhook para awtomatikong makatanggap ng task updates mula sa Meshy. Maaari kang magkaroon ng maximum na 5 aktibong webhooks bawat Meshy account. Kapag na-enable ang isang webhook, awtomatikong ipapadala ang lahat ng API task status updates sa payload URL. Para sa seguridad, sa ngayon ay https URLs lamang ang pinapayagan naming padalhan ng webhooks. Kung gusto mong i-configure ang local testing, tingnan ang susunod na seksyon.

Mga Kinakailangan sa Paghahatid ng Webhook

Para gumana nang normal ang iyong webhook at patuloy na makatanggap ng mga event:

  • Dapat tumugon ang iyong server gamit ang HTTP status code na mas mababa sa 400 (hal., 200 OK, 202 Accepted).
  • Anumang tugon na may status code na >= 400 ay ituturing na isang bigong paghahatid.
  • Ang maraming magkakasunod na kabiguan ay maaaring:
    • Magdulot ng pagka-antala o hindi pagkakasunod-sunod ng progress updates
    • Awtomatikong i-disable ang iyong webhook pagkatapos ng paulit-ulit na pagtatangka (tingnan ang Auto-Disable Policy)

Tip: Palaging magbalik ng success response pagkatapos mong i-validate at i-store ang webhook payload, kahit na asynchronous pa ang susunod na pagproseso.

Kung hindi dumating ang final event ng isang task pagkalipas ng halos dalawang beses ang karaniwang oras nito, kunin ang task gamit ang GET endpoint nito. Tingnan ang Task Lifecycle para sa karaniwang oras at kung gaano katagal dapat maghintay.

Pag-forward ng Webhooks para sa Local Testing

Kung gusto mong subukan ang iyong webhook code nang lokal, na karaniwang nasa http address, maaari kang gumamit ng webhook proxy URL para i-forward ang webhooks papunta sa iyong computer o codespace. Narito ang mga inirerekomendang hakbang gamit ang smee.io, ngunit maaari kang gumamit ng anumang serbisyo na gusto mo para bumuo ng webhook proxy URL.

Kumuha ng webhook proxy URL:

  1. Sa iyong browser, pumunta sa https://smee.io/
  2. I-click ang "Start a new channel"
  3. Kopyahin ang buong URL sa ilalim ng "Webhook Proxy URL". Gagamitin mo ang URL na ito sa mga susunod na hakbang sa setup.

I-forward ang webhooks:

  1. Kung wala ka pang naka-install na smee-client, patakbuhin ang sumusunod na command sa iyong terminal.
npm install --global smee-client
  1. Para makatanggap ng mga na-forward na webhooks mula sa smee.io, patakbuhin ang sumusunod na command sa iyong terminal. Palitan ang WEBHOOK_PROXY_URL ng iyong webhook proxy URL mula kanina.
smee --url WEBHOOK_PROXY_URL --path /webhook --port 3000

Makikita mo ang output na katulad nito, kung saan ang WEBHOOK_PROXY_URL ay ang iyong webhook proxy URL:

Forwarding WEBHOOK_PROXY_URL to http://127.0.0.1:3000/webhook
Connected WEBHOOK_PROXY_URL
  1. Panatilihin itong tumatakbo habang sinusubukan mo ang iyong webhook. Kapag gusto mong ihinto ang pag-forward ng webhooks, pindutin ang Ctrl+C.
    Tandaan na ang path ay /webhook at ang port ay 3000. Maaaring magamit ang mga value na ito kapag gusto mong mag-set up ng sarili mong code para tumanggap ng webhook deliveries sa hinaharap.

Gumawa ng webhook:

Maaari mo na ngayong gamitin ang webhook proxy URL para gumawa ng bagong webhook sa Webhooks page.

Sample na Sagot

Kapag nagbago ang status ng isang task, magpapadala ang Meshy ng webhook payload gamit ang POST papunta sa iyong na-configure na URL. Naglalaman ang payload ng task object sa JSON format. Para sa kumpletong paglalarawan ng lahat ng properties ng task object at mga halimbawang payloads, tingnan ang: