Documentation / Webhooks

Webhooks at event delivery

I-configure ang reliable transfer ng statuses at events sa pagitan ng systems: mula message creation at signature verification hanggang receipt confirmation, redelivery at error control.

Buksan ang security section
Events
statuses at changes
Signature
authenticity verification
Retries
redelivery
Control
history at diagnostics
Event flow

Mula creation hanggang confirmation

01
Gumawa ng event

Ilagay ang identifier, type, time, object, status at related data.

02
I-sign at ipadala

Ipadala ang event sa HTTPS na may signature at limited timeout.

03
Kumpirmahin ang receipt

Pagkatapos ng verification, i-save ang event at mabilis na magbalik ng successful HTTP response.

04
Mag-retry kapag may error

Ulitin ang delivery na may increasing interval at i-save ang undelivered events para sa analysis.

Overview

Nag-aabiso ang webhook tungkol sa state change

Maaaring ulitin ng sender ang delivery, kaya dapat i-verify ng receiver ang source, kumpirmahin ang receipt at i-apply ang bawat event nang isang beses lang.

Event

Record ng pagbabago sa payment, game session, KYC check, bonus, player profile o ibang object.

Confirmation

Nagbabalik ang receiver ng successful HTTP response pagkatapos ma-verify at ma-save nang maaasahan ang event.

Recovery

Nakakatulong ang retry at reconciliation na ma-recover ang data pagkatapos ng temporary unavailability ng isang system.

Event payload

Anong data ang dapat lamanin ng event

Pinapasimple ng unified message structure ang verification, routing, duplicate protection at support para sa iba't ibang event types.

Event ID

Unique value na ginagamit ng system para makilala ang redelivery at mahanap ang processing history.

Event type

Malinaw at stable na pangalan na tumutukoy sa nangyaring pagbabago at processing method.

Creation time

Petsa at oras ng event creation sa agreed format at time zone.

Related object

Type at identifier ng payment, player, round, request, bonus o ibang object.

Schema version

Nakakatulong ang version number na ligtas na baguhin ang message structure nang hindi nasisira ang existing integrations.

Operation correlation

Identifier ng original request, transaction, session o chain ng related actions.

Context

Brand, project, market, environment, provider at iba pang data na kailangan para sa tamang routing.

Event data

Minimum set ng fields para ma-process ang change o gumawa ng follow-up API request.

Signature at verification

Event authenticity at integrity verification

Bago baguhin ang data, vine-verify ng receiver ang secure connection, signature, creation time at unique event ID.

01

Kunin ang raw message

I-verify ang signature laban sa original request body bago baguhin ang JSON format.

02

Suriin ang oras

I-reject ang request kung lampas ang event time sa allowed window.

03

I-verify ang signature

Gamitin ang agreed secret at HMAC o digital signature algorithm.

04

Suriin ang identifier

Siguraduhing hindi pa na-apply ang event at i-save ang verification result.

Delivery at retries

HTTP responses at redelivery

Dapat matukoy ng sender ang successful receipt, temporary error at permanent failure, habang dapat mabilis at malinaw sumagot ang receiver.

Successful HTTP response

Kinukumpirma na na-verify at ligtas na na-save ang event para sa susunod na processing.

Limited timeout

Huwag magsagawa ng matagal na processing bago sumagot sa sender — i-save muna ang event.

Redelivery

Ulitin ang delivery kapag may temporary network error, unavailability o no response.

Increasing interval

Unti-unting dagdagan ang pause sa pagitan ng attempts para hindi magdagdag ng load.

Undelivered event queue

Pagkatapos maubos ang attempts, i-save ang event para sa diagnostics at manual processing.

Manual replay

Maaaring i-replay ng operator ang napiling event nang hindi gumagawa ng bagong operation.

Delivery monitoring

I-track ang bilang ng attempts, responses, last error at next delivery time.

Notifications

I-notify ang team kapag tumataas ang errors, nauubos ang attempts o naiipon ang events sa queue.

Event processing

Duplicate protection at status ordering

Hindi dapat umasa ang receiver sa single delivery o strict event order.

Apply once

I-save ang event ID bago baguhin ang data.
Kumpirmahin ang repeated event nang walang duplicate debit, credit o change.
I-link ang event sa object at current state nito.
I-save ang event at business change bilang iisang consistent operation.

Order at freshness

I-compare ang time, sequence number o event version.
Huwag ibalik ang object sa stale state dahil sa delayed delivery.
Payagan lamang ang valid status transitions.
Kung may duda, kunin ang current object state sa API.
Testing

Ano ang dapat i-check bago mag-launch

I-test ang successful delivery, invalid signature, retries, slow response, out-of-order events at recovery pagkatapos ng failure.

Invalid signature

Modified message, unknown key, expired time at unsupported algorithm.

Redelivery

Dumarating ang parehong event nang maraming beses bago at pagkatapos matapos ang processing.

Slow response

Masyadong matagal sumagot ang receiver, napuputol ang connection o hindi nakakarating ang confirmation sa sender.

Out-of-order processing

Dumarating ang final status bago ang intermediate status, at nade-deliver ang lumang event pagkatapos ng bago.

Unavailable endpoint

I-test ang HTTP 5xx, DNS, TLS, rate limits at full retry exhaustion.

Delivery history

Dapat makita gamit ang event ID ang lahat ng attempts, responses, errors at result ng manual replay.

Pre-launch checklist

Ini-enable ang production delivery pagkatapos ma-verify ang security, duplicate protection, redelivery at error control.

Gumagamit ang test at production environments ng magkaibang endpoints at signing secrets.
Vine-verify ang signature laban sa raw message kasama ang creation time.
Sine-save ang event ID at pinoprotektahan nito ang operations laban sa duplicate execution.
Mabilis na nagbabalik ang receiver ng successful HTTP response pagkatapos ma-save ang event.
Naka-configure ang retries, increasing interval at manual replay.
Available sa support team ang delivery history at search by identifier.

Kailangang i-configure ang reliable event delivery?

Ipadala ang listahan ng events, receiving endpoints at status-change rules. Tutulungan ng APIACE na tukuyin ang message structure, signature verification, redelivery at error control.