Open in
వెబ్హుక్ ఎండ్పాయింట్లు
ప్రతి ఎండ్పాయింట్కు ప్రత్యేక సీక్రెట్లు మరియు ఈవెంట్ ఫిల్టర్లతో అనేక వెబ్హుక్ URLలను నిర్వహించండి.
ఎండ్పాయింట్-ఆధారిత webhook వ్యవస్థ ద్వారా మీరు ప్రతి సంస్థకు బహుళ గమ్యస్థానాలను నమోదు చేయవచ్చు. ప్రతి దానికి దాని స్వంత secret, దాని స్వంత స్థితి, అలాగే event రకాల ఉపసమితికి దాని స్వంత subscription ఉంటుంది. అన్ని కొత్త ఇంటిగ్రేషన్లకు ఇది సిఫార్సు చేయబడిన నమూనా.
వెనుకకు అనుకూలత కోసం ఉంచబడినప్పటికీ, ప్రతి సంస్థకు ఒకే URLకు మాత్రమే మద్దతు ఇచ్చే లెగసీ సింగిల్-URL webhookతో పోల్చండి.
ఎండ్పాయింట్లు
| విధానం | పాత్ | అవసరమైన పాత్ర | వివరణ |
|---|---|---|---|
GET | /v1/developer/webhook-endpoints | admin+ | ఎండ్పాయింట్లను జాబితా చేయండి |
POST | /v1/developer/webhook-endpoints | admin+ | ఎండ్పాయింట్ను సృష్టించండి |
PATCH | /v1/developer/webhook-endpoints/{endpoint_id} | admin+ | లేబుల్ / URL / ఈవెంట్లు / స్థితిని నవీకరించండి |
DELETE | /v1/developer/webhook-endpoints/{endpoint_id} | admin+ | ఎండ్పాయింట్ను తొలగించండి |
POST | /v1/developer/webhook-endpoints/{endpoint_id}/rotate-secret | admin+ | సంతకం సీక్రెట్ను భర్తీ చేయండి |
POST | /v1/developer/webhook-endpoints/{endpoint_id}/test | admin+ | సంతకం చేసిన పరీక్ష డెలివరీని పంపండి |
GET | /v1/developer/webhook-deliveries | admin+ | ఇటీవలి ఎండ్పాయింట్ మరియు లెగసీ డెలివరీ ఫలితాలను పరిశీలించండి |
ఎండ్పాయింట్ ఆబ్జెక్ట్
{
"id": "c4d5e6f7-...",
"label": "Production — Call events",
"url": "https://example.com/thunderphone/hook",
"events": ["telephony.incoming", "telephony.complete"],
"status": "active",
"agent_id": 42,
"agent_name": "Support Agent",
"secret_hint": "a1b2…9f0e",
"paused_at": null,
"pause_last_error": "",
"pause_undelivered_count": null,
"created_at": "2026-04-20T18:24:10.113Z",
"updated_at": "2026-04-20T18:24:10.113Z"
}| ఫీల్డ్ | రకం | వివరణ |
|---|---|---|
id | UUID | ఎండ్పాయింట్ id |
label | స్ట్రింగ్ | ప్రదర్శన పేరు, 1–120 అక్షరాలు |
url | స్ట్రింగ్ | HTTPS URL; డెవలప్మెంట్ కోసం http://localhost అనుమతించబడుతుంది |
events | స్ట్రింగ్ల శ్రేణి | సబ్స్క్రైబ్ చేసిన ఈవెంట్ రకాలు (చెల్లుబాటు అయ్యే విలువలు చూడండి). ఖాళీ శ్రేణి స్పష్టమైన-మాత్రమే ఈవెంట్లు (telephony.turn / web.turn / call.status_changed) మినహా అన్ని ఈవెంట్లకు సబ్స్క్రైబ్ అవుతుంది |
status | స్ట్రింగ్ | active, disabled (మాన్యువల్గా నిలిపివేయబడింది), లేదా failing (ఒక్క 2xx కూడా లేకుండా డెలివరీ తన 24 h మళ్లీ ప్రయత్నించే షెడ్యూల్ను పూర్తిచేసినప్పుడు స్వయంచాలకంగా సెట్ అవుతుంది) |
agent_id | integer | null | ఈ ఎండ్పాయింట్ పరిమితం చేయబడిన ఏజెంట్; null అంటే సంస్థ-వ్యాప్తంగా ఉంటుంది |
agent_name | స్ట్రింగ్ | null | పరిమితం చేయబడిన ఏజెంట్ పేరు లేదా సంస్థ-వ్యాప్త ఎండ్పాయింట్కు null |
secret_hint | స్ట్రింగ్ | ఎలిప్సిస్తో సంతకం చేసే రహస్యం యొక్క మొదటి 4 మరియు చివరి 4 అక్షరాలు (a1b2…9f0e) — పూర్తి విలువను బహిర్గతం చేయకుండా, మీరు స్థానికంగా సేవ్ చేసిన రహస్యాన్ని సరిపోల్చడానికి సరిపోతుంది |
paused_at | టైమ్స్టాంప్ | null | ThunderPhone ఎండ్పాయింట్ను failingగా సెట్ చేసిన సమయం. అది active లేదా disabledగా ఉన్నప్పుడు null |
pause_last_error | స్ట్రింగ్ | ఎండ్పాయింట్ నిలిపివేయబడినప్పుడు వచ్చిన చివరి డెలివరీ లోపం, ఉదాహరణకు HTTP 503: Service Unavailable. failing కాకపోతే ఖాళీగా ఉంటుంది |
pause_undelivered_count | integer | null | ఎండ్పాయింట్ చివరి విజయవంతమైన డెలివరీ నుండి డెలివరీ కాని ఈవెంట్లు, అది నిలిపివేయబడినప్పుడు లెక్కించబడతాయి |
created_at, updated_at | టైమ్స్టాంప్ |
చెల్లుబాటు అయ్యే ఈవెంట్ రకాలు
events ఈ ఖచ్చితమైన సెట్తో ధ్రువీకరించబడుతుంది — జాబితా వెలుపలి విలువలు
400ను తిరిగి ఇస్తాయి. ప్రతి రకం పేలోడ్ నిర్మాణం కోసం ఈవెంట్ల కేటలాగ్ చూడండి.
telephony.incoming,telephony.complete,telephony.tool,telephony.turnweb.incoming,web.complete,web.tool,web.turnsms.sent,sms.failedsms.received(రిజర్వ్ చేయబడింది; ఇంకా పంపబడలేదు)scheduled.skipped,scheduled.failedcall.graded,call.data_extracted,call.transfer_completed,call.status_changedcampaign.completedissue.reported,issue.escalatedtest-call.completedalert.triggeredphone_number.spam_risk_changed
issue.escalated మరియు phone_number.spam_risk_changedకు ఏజెంట్ సందర్భం ఉండదు మరియు
అవి సంస్థ-వ్యాప్త ఎండ్పాయింట్లకు మాత్రమే పంపబడతాయి.
voice.ready మరియు voice.failedలను స్పష్టంగా ఎంచుకోలేరు. వాటిని స్వీకరించడానికి
events: []తో సంస్థ-వ్యాప్త ఎండ్పాయింట్ను సృష్టించండి. ఖాళీ ఈవెంట్ జాబితా ప్రతి మద్దతు ఉన్న ఈవెంట్ను స్వీకరిస్తుంది, అయితే స్పష్టంగా ఎంచుకోవాల్సిన telephony.turn, web.turn మరియు
call.status_changed మినహా.
ఎండ్పాయింట్ స్థితులు
active— డెలివరీలు సాధారణంగా కొనసాగుతాయి.disabled—PATCHద్వారా మాన్యువల్గా నిలిపివేయబడింది. ఎటువంటి రిక్వెస్ట్లు పంపబడవు. మేముdisabledఎండ్పాయింట్ స్థితిని ఎప్పుడూ మార్చము; దానిని తిరిగిactiveకి మార్చడం పూర్తిగా మీ నిర్ణయం.failing— ఎండ్పాయింట్కు డెలివరీ 2xx పొందకుండానే తన పూర్తి రీట్రై షెడ్యూల్ను (24 గంటల్లో 8 ప్రయత్నాలు) వినియోగించుకున్నప్పుడు స్వయంచాలకంగా సెట్ చేయబడుతుంది. విఫలమవుతున్న ఎండ్పాయింట్కు ఇకపై ట్రాఫిక్ అందదు. ఇలా జరిగినప్పుడు మేము మీ సంస్థ యజమానులకు మరియు అడ్మిన్లకు ఇమెయిల్ పంపుతాము, అలాగే డ్యాష్బోర్డ్లో నిలిపివేయబడిన ఎండ్పాయింట్కు Re-activate బటన్ కనిపిస్తుంది. ఎండ్పాయింట్ సరిచేయబడిన తర్వాత, దాని స్థితినిPATCHద్వారా తిరిగిactiveకి మార్చండి; ఇంకా రీట్రై షెడ్యూల్ ముగియని డెలివరీలు తాము ఆగిన చోటు నుంచే తిరిగి కొనసాగుతాయి.
ఎండ్పాయింట్లను జాబితా చేయండి
curl https://api.thunderphone.com/v1/developer/webhook-endpoints \
-H "Authorization: Bearer sk_live_YOUR_API_KEY"ఎండ్పాయింట్ ఆబ్జెక్ట్ల arrayను తిరిగి ఇస్తుంది.
ఆ ఏజెంట్కు పరిమితమైన ఎండ్పాయింట్లను మాత్రమే తిరిగి ఇవ్వడానికి ?agent_id=42 పంపండి.
ఏజెంట్-పరిమిత ఎండ్పాయింట్లు
సంస్థ-వ్యాప్త ఎండ్పాయింట్లు సరిపోలే ప్రతి ఈవెంట్ను స్వీకరిస్తాయి. agent_id ఉన్న ఎండ్పాయింట్
ఆ ఏజెంట్ నిర్వహించిన కాల్లకు సంబంధించిన సరిపోలే ఈవెంట్లను మాత్రమే స్వీకరిస్తుంది;
alert.triggered వంటి ఏజెంట్ సందర్భం లేని ఈవెంట్లు దానిని ఎప్పుడూ చేరవు. మీరు ఈ
ఎండ్పాయింట్లను ఏజెంట్ బిల్డర్లోని వెబ్హుక్స్ విభాగం నుండి కూడా సృష్టించవచ్చు మరియు నిర్వహించవచ్చు.
ఎండ్పాయింట్ సృష్టించండి
curl -X POST https://api.thunderphone.com/v1/developer/webhook-endpoints \
-H "Authorization: Bearer sk_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"label": "Production — Call events",
"url": "https://example.com/thunderphone/hook",
"events": ["telephony.incoming", "telephony.complete"]
}'result = requests.post(
"https://api.thunderphone.com/v1/developer/webhook-endpoints",
headers={"Authorization": "Bearer sk_live_YOUR_API_KEY"},
json={
"label": "Production — Call events",
"url": "https://example.com/thunderphone/hook",
"events": ["telephony.incoming", "telephony.complete"],
},
).json()
secret = result["secret"]
endpoint_id = result["id"]అభ్యర్థన ఫీల్డ్లు
| ఫీల్డ్ | రకం | అవసరం | వివరణ |
|---|---|---|---|
label | స్ట్రింగ్ | అవును | 1–120 అక్షరాలు |
url | స్ట్రింగ్ | అవును | HTTPS URL (http అనేది localhost / 127.0.0.1 కోసం మాత్రమే అనుమతించబడుతుంది) |
events | అరే | కాదు | ఖాళీగా ఉంచడం/వదిలివేయడం ద్వారా అన్ని ఈవెంట్లకు సబ్స్క్రైబ్ అవుతుంది, అయితే స్పష్టమైన సబ్స్క్రిప్షన్ అవసరమైన telephony.turn / web.turn / call.status_changed మినహా. చెల్లుబాటు అయ్యే ఈవెంట్ రకాలులో జాబితా చేసిన విలువలనే ఉపయోగించాలి; నకిలీలు తొలగించబడతాయి |
agent_id | పూర్ణాంకం | నల్ | కాదు | ఈ సంస్థలోని ఒక ఏజెంట్కు డెలివరీని పరిమితం చేయండి; సంస్థ-వ్యాప్త ఎండ్పాయింట్ కోసం వదిలివేయండి లేదా null ఉపయోగించండి |
ఎండ్పాయింట్ ఆబ్జెక్ట్తో పాటు ముడి సైనింగ్ కీని కలిగి ఉన్న అదనపు టాప్-లెవల్ secret ఫీల్డ్తో 201 Createdని అందిస్తుంది — ఇది 48-అక్షరాల హెక్స్ స్ట్రింగ్:
{
"id": "c4d5e6f7-…",
"label": "Production — Call events",
"url": "https://example.com/thunderphone/hook",
"events": ["telephony.incoming", "telephony.complete"],
"status": "active",
"secret_hint": "a1b2…9f0e",
"created_at": "2026-04-20T18:24:10.113Z",
"updated_at": "2026-04-20T18:24:10.113Z",
"secret": "a1b2c37e08d94f5b16a2c8d90e7f3a4b5c6d7e8f90a19f0e"
}ఎండ్పాయింట్ను నవీకరించండి
curl -X PATCH https://api.thunderphone.com/v1/developer/webhook-endpoints/c4d5e6f7-... \
-H "Authorization: Bearer sk_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"label": "Production — Call + Grade events",
"events": ["telephony.incoming", "telephony.complete", "call.graded"]
}'| ఫీల్డ్ | రకం | వివరణ |
|---|---|---|
label | స్ట్రింగ్ | |
url | స్ట్రింగ్ | |
events | అరే | |
status | స్ట్రింగ్ | active లేదా disabled. సర్వర్ failingగా గుర్తించిన ఎండ్పాయింట్ను మళ్లీ ప్రారంభించడానికి active సెట్ చేయండి |
agent_id | ఇంటీజర్ | null | ఎండ్పాయింట్ పరిధిని పరిమితం చేయడానికి ఏజెంట్ idని సెట్ చేయండి లేదా సంస్థ-వ్యాప్తం చేయడానికి nullని సెట్ చేయండి |
నవీకరించిన ఎండ్పాయింట్ ఆబ్జెక్ట్తో 200 OKని అందిస్తుంది.
సంతకం రహస్యాన్ని రొటేట్ చేయండి
ఎండ్పాయింట్ సైనింగ్ సీక్రెట్ పోయినప్పుడు లేదా లీక్ అయి ఉండవచ్చని అనిపించినప్పుడు దాన్ని భర్తీ చేయండి. మీరు డ్యాష్బోర్డ్ను కూడా ఉపయోగించవచ్చు: ఇంటిగ్రేషన్స్ → వెబ్హుక్స్ కింద ఎండ్పాయింట్ను తెరవండి (సంస్థ-వ్యాప్తంగా ఉన్నవి మరియు ఏజెంట్ ఎండ్పాయింట్లు రెండూ అక్కడ జాబితా చేయబడతాయి), ఆపై రొటేట్ ఎంచుకోండి.
curl -X POST https://api.thunderphone.com/v1/developer/webhook-endpoints/c4d5e6f7-.../rotate-secret \
-H "Authorization: Bearer sk_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'| ఫీల్డ్ | రకం | అవసరం | వివరణ |
|---|---|---|---|
include_copies | బూలియన్ | లేదు | డిఫాల్ట్గా true. ఈ ఎండ్పాయింట్కు ఇతర ఏజెంట్లపై ఉన్న కాపీల వంటి, ఒకే URL మరియు ఒకే ప్రస్తుత రహస్యాన్ని కలిగిన మీ సంస్థలోని ఇతర ఎండ్పాయింట్లకు కూడా కొత్త రహస్యాన్ని అందిస్తుంది, తద్వారా ఒక రిసీవర్ ఒకే రహస్యంతో ధృవీకరించడాన్ని కొనసాగిస్తుంది |
200 OKను తిరిగి అందిస్తుంది:
{
"endpoint": { "id": "c4d5e6f7-...", "secret_hint": "7f3a…c21d", "...": "..." },
"secret": "7f3a90b2c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5c21d",
"rotated_endpoint_ids": ["c4d5e6f7-..."]
}| ఫీల్డ్ | రకం | వివరణ |
|---|---|---|
endpoint | ఆబ్జెక్ట్ | కొత్త secret_hintతో కూడిన ఎండ్పాయింట్ ఆబ్జెక్ట్ |
secret | స్ట్రింగ్ | కొత్త సంతకం రహస్యం. ఈ ప్రతిస్పందనలో మాత్రమే తిరిగి అందించబడుతుంది |
rotated_endpoint_ids | UUIDల శ్రేణి | ఇప్పుడు కొత్త రహస్యాన్ని ఉపయోగిస్తున్న ప్రతి ఎండ్పాయింట్ |
పరీక్ష డెలివరీని పంపండి
సాధారణ డెలివరీ పైప్లైన్ను ఉపయోగించి, కానానికల్ JSON సీరియలైజేషన్, రెండు సిగ్నేచర్ హెడర్లు, డెలివరీ రికార్డింగ్, మరియు రీట్రై లెక్కల నిర్వహణతో సహా ఒక ఎండ్పాయింట్కు సింథటిక్ webhook.test ఈవెంట్ను పంపండి.
ఈ పరీక్ష, ఎంచుకున్న ఎండ్పాయింట్లోని events ఫిల్టర్తో సంబంధం లేకుండా దానినే లక్ష్యంగా చేసుకుంటుంది.
curl -X POST https://api.thunderphone.com/v1/developer/webhook-endpoints/c4d5e6f7-.../test \
-H "Authorization: Bearer sk_live_YOUR_API_KEY"ఎండ్పాయింట్కు ఇలాంటి ఎన్వలప్ అందుతుంది:
{
"data": {
"message": "ThunderPhone webhook test",
"sent_at": "2026-07-17T20:12:34.567890+00:00"
},
"event_id": "2ad6507c-7d19-4498-9b2d-7e8f944ab5a1",
"type": "webhook.test"
}గమ్యస్థానం లోపాన్ని ఇచ్చినా, మొదటి ప్రయత్నం తర్వాత API 200 OKని అందిస్తుంది.
డెలివరీ ఫలితం కోసం success, status, response_code, మరియు errorను పరిశీలించండి:
{
"success": true,
"event_id": "2ad6507c-7d19-4498-9b2d-7e8f944ab5a1",
"event_type": "webhook.test",
"status": "delivered",
"response_code": 204,
"error": ""
}webhook.test సింథటిక్ అయినందున ఎండ్పాయింట్ యొక్క events సబ్స్క్రిప్షన్కు జోడించలేరు.
మొదటి ప్రయత్నం విఫలమైతే, ThunderPhone దాదాపు ఒక నిమిషం తర్వాత ఒకసారి రీట్రై చేసి ఆపై ఆపివేస్తుంది; డెలివరీ డీబగ్ డెలివరీలు కింద status: "failed"గా కనిపిస్తుంది. పరీక్ష డెలివరీ ఎండ్పాయింట్ను ఎప్పుడూ failingగా గుర్తించదు.
వాస్తవ ఈవెంట్ ఆకృతికి వ్యతిరేకంగా ట్రిగ్గర్ను కాన్ఫిగర్ చేయడానికి, ఐచ్ఛిక event_typeను పంపండి.
డెలివరీ ఇప్పటికీ సింథటిక్గానే ఉంటుంది మరియు "sample": trueను కలిగి ఉంటుంది; కాల్కు సంబంధించిన నమూనాలు call_id: 0 మరియు agent_id: 0ను ఉపయోగిస్తాయి.
curl -X POST https://api.thunderphone.com/v1/developer/webhook-endpoints/c4d5e6f7-.../test \
-H "Authorization: Bearer sk_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"event_type":"call.graded"}'event_type, చెల్లుబాటు అయ్యే ఈవెంట్ రకాలులోని ఏదైనా విలువను అంగీకరిస్తుంది.
దీన్ని ఇవ్వకపోతే సాధారణ webhook.test ప్రవర్తన కొనసాగుతుంది.
కాల్-పూర్తి (telephony.complete, web.complete) మరియు call.data_extracted
నమూనాలు, నిజమైన కాల్లలో ఉన్నట్లే, ప్లేస్హోల్డర్ విలువలతో ఏజెంట్ స్వంతంగా సేకరించాల్సిన డేటా ఫీల్డ్లను
extracted_data.fields కింద కలిగి ఉంటాయి. ఎటువంటి డేటాను సేకరించని ఏజెంట్ కోసం, కాల్-పూర్తి నమూనా
నిజమైన కాల్లలో ఉన్నట్లే extracted_data: nullను పంపుతుంది, మరియు call.data_extracted
నమూనాలో fields ఖాళీగా ఉంటాయి (అటువంటి ఏజెంట్ కోసం నిజమైన కాల్లు ఆ ఈవెంట్ను ఎప్పుడూ పంపవు).
ఏజెంట్ యొక్క కాల్ సారాంశం ఆఫ్లో ఉన్నప్పుడు నమూనా యొక్క summary విలువ nullగా ఉంటుంది. ఏజెంట్
ఎండ్పాయింట్లో నమూనా ఆ ఏజెంట్ను అనుసరిస్తుంది; సంస్థ-వ్యాప్త ఎండ్పాయింట్లో, దానిని ఒక ఏజెంట్ ఆధారంగా
రూపొందించడానికి ఐచ్ఛిక agent_idను పంపండి లేదా సాధారణ నమూనా కోసం దాన్ని వదిలివేయండి.
ఎండ్పాయింట్ను తొలగించండి
curl -X DELETE https://api.thunderphone.com/v1/developer/webhook-endpoints/c4d5e6f7-... \
-H "Authorization: Bearer sk_live_YOUR_API_KEY"204 No Contentని అందిస్తుంది. URLకు డెలివరీ వెంటనే ఆగిపోతుంది;
పురోగతిలో ఉన్న రీట్రైలు నిలిపివేయబడతాయి.
డీబగ్ డెలివరీలు
వెబ్హుక్ పంపలేదని నిర్ధారించే ముందు,
GET /v1/developer/webhook-deliveriesను పరిశీలించండి.
ఇది కాల్ ఐడి, URL మూలం, HTTP స్థితి, ప్రయత్నాల సంఖ్య, అనుమతిజాబితాలోని వైఫల్య వర్గం మరియు తదుపరి
రీట్రై సమయంతో సహా, రెండు వెబ్హుక్ వ్యవస్థల నుంచి ఇటీవలి ప్రయత్నాలను చూపిస్తుంది. ఇది ఈవెంట్ పేలోడ్, ట్రాన్స్క్రిప్ట్, నిల్వ చేసిన లోప వచనం,
ప్రతిస్పందన బాడీ లేదా URL పాత్ను ఎప్పుడూ తిరిగి ఇవ్వదు.
మీరు ఇదే ఇటీవలి చరిత్రను ఏజెంట్లు → ఒక ఏజెంట్ను ఎంచుకోండి → వెబ్హుక్స్ → ఇటీవలి డెలివరీలులో కూడా చూడవచ్చు. వరుసలు ఎండ్పాయింట్ లేబుల్ మరియు తాజా ప్రయత్నం ఉపయోగించిన URL మూలాన్ని చూపిస్తాయి. ఇది మార్పులేనిది అయిన ఆడిట్ లాగ్ కాకుండా కార్యాచరణ స్థితి: ఎండ్పాయింట్ను తొలగిస్తే దాని డెలివరీ వరుసలు కూడా తొలగించబడతాయి.
n8n 404 కోసం, ముందుగా వర్క్ఫ్లో సక్రియంగా ఉందని, POSTను అంగీకరిస్తోందని, మరియు పరీక్ష URL కాకుండా
ప్రొడక్షన్ వెబ్హుక్ URLను ఉపయోగిస్తోందని నిర్ధారించండి. 401 లేదా 403 ప్రామాణీకరణ లేదా సిగ్నేచర్ ధృవీకరణను సూచిస్తుంది;
టైమ్అవుట్లు గమ్యస్థాన లేటెన్సీ లేదా అందుబాటును సూచిస్తాయి; TLS లోపాలు సర్టిఫికేట్ చైన్, హోస్ట్నేమ్ లేదా గడువు ముగింపును సూచిస్తాయి.