Open in
Webhook एंडपॉइंट्स
प्रत्येक एंडपॉइंटसाठी स्वतंत्र secrets आणि इव्हेंट फिल्टर्ससह अनेक webhook URLs व्यवस्थापित करा.
एंडपॉइंट-आधारित webhook प्रणाली तुम्हाला प्रत्येक संस्थेसाठी अनेक गंतव्ये नोंदणी करण्याची सुविधा देते. प्रत्येकाचे स्वतःचे secret, स्वतःची स्थिती आणि इव्हेंट प्रकारांच्या उपसंचासाठी स्वतःचे subscription असते. सर्व नवीन इंटिग्रेशनसाठी हे शिफारस केलेले मॉडेल आहे.
लेगसी single-URL webhook शी तुलना करा, जे backward compatibility साठी ठेवले आहे, परंतु प्रत्येक संस्थेसाठी फक्त एक URL समर्थित करते.
एंडपॉइंट्स
| पद्धत | मार्ग | आवश्यक भूमिका | वर्णन |
|---|---|---|---|
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 | एंडपॉइंट आयडी |
label | string | प्रदर्शन नाव, 1–120 वर्ण |
url | string | HTTPS URL; विकासासाठी http://localhost अनुमत आहे |
events | string चा अॅरे | सदस्यत्व घेतलेले इव्हेंट प्रकार (वैध मूल्ये पहा). रिकामा अॅरे केवळ स्पष्टपणे निवडावे लागणारे इव्हेंट (telephony.turn / web.turn / call.status_changed) वगळता सर्व इव्हेंटचे सदस्यत्व घेतो |
status | string | active, disabled (स्वहस्ते थांबवलेले), किंवा failing (कोणतेही 2xx न मिळता एखादे वितरण 24 तासांचे पुनर्प्रयत्न वेळापत्रक संपवते तेव्हा आपोआप सेट केलेले) |
agent_id | integer | null | हा एंडपॉइंट ज्या एजंटपुरता मर्यादित आहे; null म्हणजे संस्थाव्यापी |
agent_name | string | null | मर्यादित एजंटचे नाव, किंवा संस्थाव्यापी एंडपॉइंटसाठी null |
secret_hint | string | इलिप्सिससह साइनिंग सीक्रेटची पहिली 4 आणि शेवटची 4 वर्णे (a1b2…9f0e) — पूर्ण मूल्य उघड न करता तुम्ही स्थानिकरीत्या जतन केलेल्या सीक्रेटशी पडताळून पाहण्यासाठी पुरेसे |
paused_at | timestamp | null | ThunderPhone ने एंडपॉइंट failing वर सेट केलेली वेळ. तो active किंवा disabled असताना null |
pause_last_error | string | एंडपॉइंट थांबवला असताना झालेली शेवटची वितरण त्रुटी, उदाहरणार्थ HTTP 503: Service Unavailable. failing नसल्यास रिक्त |
pause_undelivered_count | integer | null | एंडपॉइंटच्या शेवटच्या यशस्वी वितरणापासून वितरित न झालेले इव्हेंट, तो थांबवला असताना मोजलेले |
created_at, updated_at | timestamp |
वैध इव्हेंट प्रकार
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— एंडपॉइंटकडे पाठवलेली डिलिव्हरी संपूर्ण पुनःप्रयत्न वेळापत्रक (24 तासांत 8 प्रयत्न) वापरूनही कधीही 2xx न मिळाल्यास आपोआप सेट होते. अयशस्वी एंडपॉइंटला पुढील कोणताही ट्रॅफिक मिळत नाही. असे झाल्यावर आम्ही तुमच्या संस्थेच्या मालकांना आणि प्रशासकांना ईमेल पाठवतो, आणि डॅशबोर्डमध्ये थांबवलेला एंडपॉइंट पुनः-सक्रिय करा बटणासह दिसतो. एंडपॉइंट दुरुस्त झाल्यावर, त्याची स्थिती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 | नाही | या संस्थेतील एजंटपर्यंत वितरण मर्यादित करा; संस्थाव्यापी एंडपॉइंटसाठी वगळा किंवा null वापरा |
Endpoint ऑब्जेक्ट सह 201 Created आणि कच्ची साइनिंग की असलेले अतिरिक्त शीर्ष-स्तरीय secret फील्ड परत करते — 48-वर्णांची hex स्ट्रिंग:
{
"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 सेट करा |
अपडेट केलेल्या Endpoint ऑब्जेक्टसह 200 OK परत करते.
स्वाक्षरी गुपित बदला
उदाहरणार्थ, एंडपॉइंटचा साइनिंग सिक्रेट हरवला असेल किंवा लीक झाला असण्याची शक्यता असेल तर तो बदला. तुम्ही डॅशबोर्डदेखील वापरू शकता: Integrations → Webhooks अंतर्गत एंडपॉइंट उघडा (संस्थेतील आणि एजंट एंडपॉइंट दोन्ही तेथे सूचीबद्ध असतात) आणि रोटेट निवडा.
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 ची अॅरे | आता नवीन गुपित वापरणारा प्रत्येक एंडपॉइंट |
चाचणी वितरण पाठवा
सामान्य वितरण पाइपलाइन वापरून एका एंडपॉइंटला कृत्रिम webhook.test इव्हेंट पाठवा. यामध्ये कॅनॉनिकल JSON सीरियलायझेशन, दोन्ही स्वाक्षरी हेडर्स, वितरण रेकॉर्डिंग आणि पुनःप्रयत्न नोंदणी समाविष्ट असते.
ही चाचणी निवडलेल्या एंडपॉइंटच्या 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 त्रुटी प्रमाणपत्र साखळी, होस्टनेम किंवा कालबाह्यतेकडे निर्देश करतात.