រំកិលទៅមាតិកា

រៀបចំការបញ្ជូន Outbound Webhook

ការរៀបចំរហ័ស

សណ្ឋាគារភាគច្រើនបញ្ចប់ការរៀបចំនេះក្នុងរយៈពេល 5 ទៅ 10 នាទី។

មគ្គុទ្ទេសក៍នេះជួយអ្នកផ្ញើ event JSON guest_verified បន្ទាប់ពីការផ្ទៀងផ្ទាត់ភ្ញៀវ និងការធ្វើសមកាលកម្ម PMS។

ចូលទៅកាន់៖ Settings → Outbound Webhook

Signature header

រាល់ការបញ្ជូនរួមមាន X-Vouch-Signature។ ប្រព័ន្ធទទួលរបស់អ្នកគួរតែផ្ទៀងផ្ទាត់ header នោះ មុនពេលទុកចិត្តលើ payload។

តម្លៃរសើប

អ្នកដែលអាចចូលប្រើទំព័រនេះ អាចមើលឃើញតម្លៃ header ដែលបានរក្សាទុក និង HMAC signing secret។ Delivery logs បង្ហាញ request payloads ពេញលេញ និង response details។ Audit change records នៅតែបិទបាំងតម្លៃទាំងនេះ។ ការពារសិទ្ធិចូលប្រើ Settings → Outbound Webhook និងជៀសវាងការចែករំលែក screenshots។

ឯកសារយោងរហ័ស

Settingវាគ្រប់គ្រងអ្វីអ្វីដែលអ្នកឃើញ
Enabledបើក ឬបិទការបញ្ជូន outbound webhooktoggle នៅតែបើក បន្ទាប់ពីអ្នករក្សាទុក
Webhook URLURL គោលដៅសម្រាប់ការបញ្ជូនAVA ទទួលយក URL របស់ receiver
Headersstatic auth headers សម្រាប់ receiverតម្លៃដែលបានរក្សាទុកនៅតែអាចមើលឃើញ បន្ទាប់ពីរក្សាទុក
Payload Fieldsវាលភ្ញៀវដែលត្រូវផ្ញើមានតែវាលដែលបានធីកប៉ុណ្ណោះ បង្ហាញក្នុង deliveries
Marketing consentការរួមបញ្ចូល marketingConsent កម្រិតខាងលើstatus card បង្ហាញ Included ឬ Omitted
Max attemptsចំនួន retry សម្រាប់ការបញ្ជូនដែលបរាជ័យតម្លៃនៅចន្លោះ 1 និង 10
HMAC signing secretការចុះហត្ថលេខាលើ payload សម្រាប់ការបញ្ជូននីមួយៗតម្លៃដែលបានរក្សាទុកនៅតែអាចមើលឃើញ; តម្រូវឱ្យមានពេលបើក ឬធ្វើតេស្ត
Send Testផ្ញើការបញ្ជូនសាកល្បងមួយការសាកល្បងចុងក្រោយបង្ហាញក្នុង Delivery Logs
Delivery Logsស្ថានភាព និង payloads នៃការបញ្ជូនថ្មីៗអ្នកឃើញ 10 records ក្នុងមួយទំព័រ រួមទាំង status, attempts, HTTP status, response body, payload details និង page navigation

មុនពេលចាប់ផ្តើម

បញ្ជាក់មូលដ្ឋានទាំងនេះ៖

  • អ្នកមានសិទ្ធិ settings:write
  • អ្នកស្គាល់ URL របស់ receiver
  • អ្នកស្គាល់ static auth headers ដែលត្រូវការ
  • អ្នកមាន HMAC signing secret
  • អ្នកស្គាល់វាលភ្ញៀវដែល receiver ត្រូវការ
តម្លៃ secret ដែលបានរក្សាទុក

តម្លៃ header និង HMAC signing secret ដែលបានរក្សាទុក នៅតែអាចមើលឃើញបន្ទាប់ពីអ្នករក្សាទុក។ បញ្ចូលតម្លៃថ្មី នៅពេលអ្នកត្រូវការ rotate secret។

ពេលវាផ្ញើ

AVA ផ្ញើ webhook បន្ទាប់ពីការផ្ទៀងផ្ទាត់ភ្ញៀវបានជោគជ័យ។ ឈ្មោះ event គឺ guest_verified។ AVA មិនផ្ញើ webhook ទេ ប្រសិនបើការធ្វើសមកាលកម្ម PMS បរាជ័យ។

សំណើប្រើ JSON POST។ AVA រួមបញ្ចូល static headers របស់អ្នកក្នុង delivery រាល់លើក។

កំណត់រចនាសម្ព័ន្ធ Webhook

បើកវា

  1. ចូលទៅកាន់ Settings → Outbound Webhook

  2. បើក Enabled

  3. បញ្ចូល Webhook URL

  4. ចុច Save

    ✓ AVA រក្សាទុក endpoint សម្រាប់ការបញ្ជូននៅពេលក្រោយ។

បន្ថែម Custom Headers

ប្រើ headers នៅពេល receiver របស់អ្នករំពឹងទុកការផ្ទៀងផ្ទាត់អត្តសញ្ញាណថេរ។ AVA ផ្ញើ headers ទាំងនេះក្នុង JSON POST រាល់លើក។ ឧទាហរណ៍ អ្នកអាចផ្ញើ Authorization: token api_key:api_secret

  1. ចុច Add

  2. បញ្ចូលឈ្មោះ header។

  3. បញ្ចូលតម្លៃ header។

  4. បើក Secret សម្រាប់តម្លៃរសើប។

  5. ចុច Save

    ✓ តម្លៃ header ដែលបានរក្សាទុក នៅតែអាចមើលឃើញបន្ទាប់ពីរក្សាទុក។

ជ្រើសរើស Payload Fields

ជ្រើសរើសវាលដែល receiver របស់អ្នកត្រូវការពី Payload Fields card។ catalog រួមមាន reservation fields និងវាលទាំងអស់ពី Settings → Check-In → Registration Form។ Marketing consent មិនមែនជាផ្នែកនៃ checklist នេះទេ។

  1. ធីកវាលនីមួយៗដែលអ្នកចង់ផ្ញើ។

  2. ដោះធីកវាលណាដែល receiver របស់អ្នកមិនត្រូវការ។

  3. ចុច Save

    ✓ មានតែវាលដែលបានធីកប៉ុណ្ណោះ ដែលបង្ហាញក្នុង deliveries នៅពេលក្រោយ។

Payload Fields ដែលមាន

GroupField in AVAJSON property
ReservationConfirmation numberreservation.confirmationNumber
ReservationArrival datereservation.arrivalDate
ReservationDeparture datereservation.departureDate
GuestFirst nameguest.firstName
GuestLast nameguest.lastName
GuestEmailguest.email
GuestPhoneguest.phone
GuestNationalityguest.nationality
GuestDocument numberguest.documentNumber
GuestDate of birthguest.birthDate
GuestPostal codeguest.postalCode
GuestCountry of residenceguest.countryCode
GuestAddressguest.addressLine
GuestCityguest.cityName
GuestState or provinceguest.stateProv
GuestPurpose of stayguest.purposeOfStay
GuestEstimated arrival timeguest.preCheckInTime
GuestGenderguest.gender
GuestOccupationguest.occupation
GuestPlace of departureguest.placeOfDeparture
GuestNext destinationguest.nextDestination
GuestDeparture timeguest.departureTime

ប្រសិនបើវាលដែលបានជ្រើសរើសទទេ AVA អាចលុប property នោះចេញពី JSON។ Purpose of stay និង Estimated arrival time អាចប្រើតម្លៃ check-in ដែលបានរក្សាទុក។ AVA បញ្ចូលផ្នែកអាសយដ្ឋានចូលគ្នា សម្រាប់ Place of departure និង Next destination។ ប្រសិនបើភ្ញៀវជ្រើសរើសអាសយដ្ឋានបច្ចុប្បន្ន AVA ប្រើអាសយដ្ឋាននោះសម្រាប់ destination។

Marketing consent card បង្ហាញតម្លៃចំនួនបួន៖

  • Guest prompt — ថាតើភ្ញៀវឃើញ marketing opt-in ឬអត់
  • Collection setting — consent model ដែល PMS របស់អ្នកប្រើ
  • Registration field — ថាតើ Marketing consent អាចមើលឃើញឬអត់
  • Webhook payload — ថាតើ AVA រួមបញ្ចូល marketingConsent ឬអត់

Payload Fields checklist មិនផ្លាស់ប្តូរតម្លៃទាំងនេះទេ។

  1. ចូលទៅកាន់ Settings → Check-In → Card & Consent

  2. សម្រាប់ consent លម្អិត បើក Promotional Mailing List

  3. សម្រាប់ consent ទូទៅ បើក Show marketing email opt-in during signature

  4. ចូលទៅកាន់ Settings → Check-In → Registration Form

  5. កំណត់ Show to ជា All guests សម្រាប់ Marketing consent

  6. រក្សាទុកទំព័រកំណត់ទាំងពីរ។

    ✓ status card បង្ហាញ Included នៅពេលលក្ខខណ្ឌចាំបាច់ទាំងពីររួចរាល់។ ✓ AVA ផ្ញើ truefalse ដោយផ្អែកលើជម្រើសរបស់ភ្ញៀវ។

AVA លុប marketingConsent ចេញ នៅពេល opt-in ត្រូវបានបិទ ឬវាលត្រូវបានលាក់។ ការយល់ព្រមទទួលការទំនាក់ទំនងតាម Phone និង email មិនបើក marketing consent ដោយខ្លួនឯងទេ។

កំណត់ Retry Attempts និង Signing Secret

ប្រើ retries សម្រាប់ការបរាជ័យក្នុងការបញ្ជូនជាបណ្តោះអាសន្ន។ កំណត់ signing secret ដើម្បីឱ្យ receiver របស់អ្នកអាចផ្ទៀងផ្ទាត់ payload នីមួយៗ។

  1. បញ្ចូលតម្លៃក្នុង Max attempts

  2. ប្រើតម្លៃចាប់ពី 1 ដល់ 10។

  3. បញ្ចូល HMAC signing secret របស់អ្នក។

  4. ចុច Save

    ✓ AVA retry លើការបរាជ័យ 429, 5xx និង timeout។ ✓ Validation និង authentication errors នៅក្នុង log ដោយមិន retry។

ជំនួស Secret ដែលបានរក្សាទុក

ប្រើវិធីនេះ នៅពេល header secret ឬ signing secret មានរួចហើយ។ តម្លៃដែលបានរក្សាទុកបច្ចុប្បន្ន បង្ហាញដោយផ្ទាល់ក្នុង field របស់វា។

  1. ជ្រើសរើសតម្លៃបច្ចុប្បន្ននៅក្នុង header ឬ HMAC field។

  2. បញ្ចូលតម្លៃថ្មី។

  3. ចុច Save

    ✓ តម្លៃថ្មីបង្ហាញបន្ទាប់ពីរក្សាទុក ហើយអនុវត្តចំពោះ deliveries នៅពេលក្រោយ។

ផ្ញើការបញ្ជូនសាកល្បង

ប្រើ test delivery បន្ទាប់ពីអ្នករក្សាទុកការកំណត់របស់អ្នក។ ការសាកល្បងប្រើ configuration ដែលបានរក្សាទុកចុងក្រោយ។ វាក៏ប្រើ HMAC signing secret ដែលបានរក្សាទុកផងដែរ។

  1. ចុច Send Test

  2. រង់ចាំសារជោគជ័យ។

  3. បើក Delivery Logs ដើម្បីបញ្ជាក់ថា row ថ្មីបង្ហាញឡើង។

    ✓ row ថ្មីបំផុតបង្ហាញ test delivery

រក្សាទុកជាមុន

ប្រសិនបើអ្នកផ្លាស់ប្តូរអ្វីមួយលើទំព័រ សូមរក្សាទុកជាមុនសិន មុនពេលផ្ញើ test។ AVA បិទប៊ូតុង test រហូតដល់ការផ្លាស់ប្តូរដែលមិនទាន់រក្សាទុកត្រូវបានសម្អាត។

ពិនិត្យ Delivery Logs

Delivery logs ជួយអ្នកពិនិត្យការព្យាយាមថ្មីៗ។ ទំព័រនីមួយៗបង្ហាញ 10 rows។ row នីមួយៗបង្ហាញ delivery status, timestamp, attempts, HTTP status និង details។ អ្នកក៏អាចបើក request payload ពេញលេញ និង response body បាន។ ប្រើ page controls ដើម្បីផ្លាស់ទីរវាង deliveries ចាស់ជាង និងថ្មីជាង។

Statusវាមានន័យថា
deliveredreceiver បានទទួលយក delivery
processingAVA កំពុងដំណើរការ delivery
retryingAVA នឹងព្យាយាមម្តងទៀតនៅពេលក្រោយ
pendingAVA បានដាក់ delivery ចូលជួរ
failedAVA បានបញ្ឈប់ការ retry delivery នោះ
  1. ចុច Refresh delivery logs ដើម្បីផ្ទុកទំព័របច្ចុប្បន្នឡើងវិញ។

  2. ប្រើ First page, Previous, NextLast page នៅពេលមានលទ្ធផលច្រើន។

  3. បើក row មួយ ដើម្បីពិនិត្យ response details។

  4. ពង្រីក View request payload ប្រសិនបើអ្នកត្រូវការមើល JSON ដែលបានផ្ញើ។

  5. ពង្រីក View response ដើម្បីពិនិត្យ response body ពិតប្រាកដរបស់ receiver។

    ✓ page counter បង្ហាញ Page X of Y នៅពេលមានច្រើនទំព័រ។ ✓ controls នៅតែអាចប្រើបាន រហូតដល់អ្នកទៅដល់ទំព័រដំបូង ឬចុងក្រោយ។

ព័ត៌មានលម្អិតរសើបក្នុង log

Delivery logs បង្ហាញ request payload ពិតប្រាកដ និង response body ដែល receiver របស់អ្នកបានបញ្ជូនត្រឡប់។ Payloads អាចរួមមានទិន្នន័យភ្ញៀវ ដូច្នេះសូមពង្រីក details តែនៅពេលដោះស្រាយបញ្ហាប៉ុណ្ណោះ។

ការដោះស្រាយបញ្ហា

ទំព័រមិនអាចផ្ទុកបាន

អ្វីដែលអ្នកឃើញ៖ អ្នកឃើញ Unable to load outbound webhook settings

វិធីដោះស្រាយ៖

  1. ចុច Retry
  2. Refresh ទំព័រ។
  3. បញ្ជាក់ថាអ្នកស្ថិតក្នុង property ត្រឹមត្រូវ។
  4. ប្រសិនបើចាំបាច់ សាកល្បងម្តងទៀតបន្ទាប់ពី sign in ម្តងទៀត។

Save បរាជ័យនៅពេលអ្នកបើក webhook

អ្វីដែលអ្នកឃើញ៖ Save បរាជ័យ បន្ទាប់ពីអ្នកបើក Enabled

វិធីដោះស្រាយ៖

  1. បញ្ចូល HMAC signing secret
  2. រក្សាទុកម្តងទៀត។
  3. ប្រសិនបើអ្នកមាន secret រួចហើយ សូមជំនួសវា ជំនួសឱ្យការលុបវាចេញ។

Send Test នៅតែបិទ

អ្វីដែលអ្នកឃើញ៖ Send Test ត្រូវបានបិទ បន្ទាប់ពីអ្នកកែទំព័រ។

វិធីដោះស្រាយ៖

  1. ចុច Save ជាមុនសិន។
  2. រង់ចាំសារជោគជ័យ។
  3. សាកល្បង Send Test ម្តងទៀត។
  4. បញ្ជាក់ថាអ្នកមាន settings permission។

Webhook URL ត្រូវបានបដិសេធ

អ្វីដែលអ្នកឃើញ៖ Save ឬ test បរាជ័យសម្រាប់ destination URLs មួយចំនួន។

វិធីដោះស្រាយ៖

  1. ប្រើ public HTTPS URL។
  2. លុប private, reserved, loopback និង site-local addresses ចេញ។
  3. សាកល្បងម្តងទៀតជាមួយ public receiver។

Delivery logs នៅទទេ

អ្វីដែលអ្នកឃើញ៖ Delivery Logs មិនទាន់បង្ហាញ rows ទេ។

វិធីដោះស្រាយ៖

  1. ចុច Send Test
  2. រង់ចាំ guest verification event។
  3. ចុច Refresh delivery logs
  4. ពិនិត្យ page counter និង page controls ប្រសិនបើអ្នករំពឹង deliveries ចាស់ៗ។
  5. ពិនិត្យម្តងទៀតបន្ទាប់ពី check-in បន្ទាប់ដែលមានលក្ខខណ្ឌត្រឹមត្រូវ។
  6. ប្រើ Last page ប្រសិនបើអ្នកត្រូវការលោតទៅ deliveries ចាស់ៗយ៉ាងលឿន។

Registration fields ថ្មីបាត់

អ្វីដែលអ្នកឃើញ៖ Registration field មិនបង្ហាញក្នុង Payload Fields

វិធីដោះស្រាយ៖

  1. Refresh Settings → Outbound Webhook
  2. បញ្ជាក់ថាទំព័របានផ្ទុកដោយគ្មាន error។
  3. ពិនិត្យ field ជាមួយតារាង Payload Fields Available ខាងលើ។
  4. បើក Settings → Check-In → Registration Form
  5. កំណត់ Show to ជា All guests ប្រសិនបើភ្ញៀវត្រូវផ្តល់តម្លៃរបស់វា។
  6. រក្សាទុក registration form ហើយផ្ទុក webhook page ឡើងវិញ។

Visibility controls ការប្រមូលទិន្នន័យភ្ញៀវ។ វាមិនគ្រប់គ្រងថា field បង្ហាញក្នុង webhook catalog ឬអត់ទេ។

អ្វីដែលអ្នកឃើញ៖ webhook មិនរួមបញ្ចូល marketingConsent

វិធីដោះស្រាយ៖

  1. បើក Settings → Check-In → Card & Consent
  2. បើក marketing opt-in ដែលបង្ហាញដល់ភ្ញៀវឱ្យត្រឹមត្រូវ។
  3. បើក Settings → Check-In → Registration Form
  4. កំណត់ Show to ជា All guests សម្រាប់ Marketing consent
  5. រក្សាទុកទំព័រកំណត់ទាំងពីរ។
  6. បញ្ជាក់ថា status card បង្ហាញ Included
  7. បញ្ចប់ការផ្ទៀងផ្ទាត់ភ្ញៀវថ្មីម្នាក់។

AVA លុប property នេះចេញ នៅពេលភ្ញៀវមិនអាចមើលឃើញ opt-in ឬ field។ ទាក់ទង support ប្រសិនបើ setting អាចមើលឃើញ ប៉ុន្តែ property នៅតែបាត់។

នៅតែជាប់?

ទាក់ទង success@vouch-technologies.com ប្រសិនបើ៖

  • ❌ ទំព័រនៅតែមិនផ្ទុក បន្ទាប់ពី retry
  • ❌ Save បរាជ័យ បន្ទាប់ពីអ្នកបន្ថែម HMAC signing secret
  • ❌ Test deliveries មិនបង្ហាញក្នុង logs

សូមបញ្ចូល៖

  • URL របស់ receiver ដែលអ្នកកំពុងប្រើ
  • ឈ្មោះ headers ណាមួយដែលអ្នកបានបន្ថែម
  • screenshot នៃ Delivery Logs card ដែលបានបិទបាំង secrets និងទិន្នន័យភ្ញៀវ