Documentation / Webhooks

Webhooks మరియు event delivery

Systems మధ్య reliable status మరియు event delivery‌ను set up చేయండి: message creation మరియు signature verification నుండి receipt acknowledgement, redelivery మరియు error monitoring వరకు.

Security section తెరవండి
Events
statuses మరియు changes
Signature
authenticity verification
Retries
redelivery
Monitoring
history మరియు diagnostics
Event flow

Creation నుండి acknowledgement వరకు

01
Event create చేయండి

Identifier, type, time, object, status మరియు related data specify చేయండి.

02
Sign చేసి పంపండి

Signature మరియు limited timeout‌తో event‌ను HTTPS ద్వారా పంపండి.

03
Receipt acknowledge చేయండి

Verification తర్వాత event‌ను store చేసి త్వరగా successful HTTP response return చేయండి.

04
Error వచ్చినప్పుడు retry చేయండి

Increasing intervals‌తో delivery retry చేసి, undelivered events‌ను investigation కోసం retain చేయండి.

Overview

Webhook state change‌ను తెలియజేస్తుంది

Sender delivery retry చేయవచ్చు, కాబట్టి recipient source verify చేసి, receipt acknowledge చేసి, ప్రతి event‌ను ఒక్కసారి మాత్రమే apply చేయాలి.

Event

Payment, game session, KYC check, bonus, player profile లేదా మరో object‌లో మార్పు record.

Acknowledgement

Event verify చేసి reliable‌గా store చేసిన తర్వాత recipient successful HTTP response return చేస్తుంది.

Recovery

ఏదైనా system తాత్కాలికంగా unavailable అయిన తర్వాత redelivery మరియు reconciliation data restore చేయడంలో సహాయపడతాయి.

Event structure

Event‌లో ఏమి ఉండాలి

Consistent message structure verification, routing, duplicate protection మరియు different event types support‌ను సులభం చేస్తుంది.

Event identifier

Redelivery గుర్తించడానికి మరియు processing history కనుగొనడానికి system ఉపయోగించే unique value.

Event type

ఏ change జరిగిందో మరియు దాన్ని ఎలా process చేయాలో నిర్వచించే clear, stable name.

Creation time

Agreed format మరియు time zone‌లో event create అయిన date మరియు time.

Related object

Payment, player, round, request, bonus లేదా మరో object type మరియు identifier.

Schema version

Active integrations‌ను disturb చేయకుండా message structure‌ను safely change చేయడానికి version number సహాయపడుతుంది.

Operation correlation

Original request, transaction, session లేదా related actions chain identifier.

Context

Correct routing కోసం అవసరమైన brand, project, market, environment, provider మరియు ఇతర data.

Event data

Change process చేయడానికి లేదా subsequent API request చేయడానికి అవసరమైన minimum fields set.

Signature మరియు verification

Event authenticity మరియు integrity verify చేయడం

Data మార్చే ముందు recipient secure connection, signature, creation time మరియు unique event identifier verify చేస్తుంది.

01

Raw message capture చేయండి

JSON format మార్చే ముందు raw request body‌పై signature verify చేయండి.

02

Timestamp తనిఖీ చేయండి

Event time permitted window బయట ఉంటే request reject చేయండి.

03

Signature verify చేయండి

Agreed secret మరియు HMAC లేదా digital-signature algorithm ఉపయోగించండి.

04

Identifier తనిఖీ చేయండి

Event ఇప్పటికే apply కాలేదని confirm చేసి verification result store చేయండి.

Delivery మరియు retries

HTTP responses మరియు redelivery

Sender successful receipt, temporary error మరియు permanent failure మధ్య తేడా గుర్తించాలి; recipient త్వరగా మరియు స్పష్టంగా respond చేయాలి.

Successful HTTP response

Event verify చేసి further processing కోసం reliable‌గా store చేశారని confirm చేస్తుంది.

Limited timeout

Sender‌కు response ఇవ్వకముందు lengthy processing చేయవద్దు — ముందుగా event store చేయండి.

Redelivery

Temporary network error, unavailability లేదా response లేకపోతే delivery retry చేయండి.

Increasing retry interval

Additional load రాకుండా attempts మధ్య delay‌ను క్రమంగా పెంచండి.

Undelivered event queue

అన్ని attempts ముగిసిన తర్వాత diagnostics మరియు manual handling కోసం event retain చేయండి.

Manual redelivery

కొత్త operation create చేయకుండా operator selected event‌ను resend చేయవచ్చు.

Delivery monitoring

Attempts count, responses, latest error మరియు next delivery time track చేయండి.

Alerts

Errors పెరిగినప్పుడు, retries exhaust అయినప్పుడు లేదా events queue‌లో accumulate అయినప్పుడు team‌కు alert చేయండి.

Event processing

Duplicate protection మరియు status ordering

Recipient single delivery లేదా strict event ordering‌పై ఆధారపడకూడదు.

ఒక్కసారి మాత్రమే apply చేయండి

Data మార్చే ముందు event identifier store చేయండి.
Repeated event‌కు మరో debit, credit లేదా state change లేకుండా acknowledge చేయండి.
Event‌ను object మరియు దాని current state‌తో link చేయండి.
Event మరియు business change‌ను ఒక consistent operation‌గా store చేయండి.

Ordering మరియు freshness

Timestamp, sequence number లేదా event version compare చేయండి.
Older event ఆలస్యంగా వచ్చినప్పుడు object‌ను outdated state‌కు తిరిగి మార్చవద్దు.
Statuses మధ్య valid transitions మాత్రమే allow చేయండి.
ఏ సందేహం ఉన్నా API ద్వారా current object state request చేయండి.
Testing

Launch‌కు ముందు ఏమి test చేయాలి

Successful delivery, invalid signatures, duplicates, slow responses, out-of-order events మరియు failure తర్వాత recovery test చేయండి.

Invalid signature

Modified message, unknown key, expired timestamp మరియు unsupported algorithm.

Redelivery

Processing complete అయ్యే ముందు మరియు తర్వాత అదే event అనేకసార్లు వస్తుంది.

Slow response

Recipient respond చేయడానికి చాలా సమయం తీసుకుంటుంది, connection drop అవుతుంది లేదా acknowledgement sender‌కు చేరదు.

Out-of-order processing

Intermediate status కంటే ముందు final status వస్తుంది, అలాగే newer event తర్వాత older event deliver అవుతుంది.

Unavailable endpoint

HTTP 5xx errors, DNS, TLS, rate limits మరియు retry attempts పూర్తిగా exhaust అవ్వడాన్ని test చేయండి.

Delivery history

Event identifier ద్వారా అన్ని attempts, responses, errors మరియు manual redelivery results search చేయగలిగేలా ఉండాలి.

Pre-launch checklist

Security, duplicate protection, redelivery మరియు error monitoring verify చేసిన తర్వాత production delivery enable చేయబడుతుంది.

Test మరియు production environments వేర్వేరు endpoints మరియు signing secrets ఉపయోగిస్తాయి.
Signature raw message మరియు creation time‌తో కలిసి verify చేయబడుతుంది.
Event identifier store చేయబడుతుంది మరియు operations ఒకటి కంటే ఎక్కువసార్లు execute కాకుండా రక్షిస్తుంది.
Event store చేసిన తర్వాత recipient త్వరగా successful HTTP response return చేస్తుంది.
Retries, increasing intervals మరియు manual redelivery configure చేయబడ్డాయి.
Delivery history మరియు identifier-based search support team‌కు అందుబాటులో ఉన్నాయి.

Reliable event delivery set up చేయాలా?

Event list, receiving endpoints మరియు status transition rules ఇవ్వండి. APIACE message structure, signature verification, redelivery మరియు error monitoring నిర్వచించడంలో సహాయపడుతుంది.