Open in
Webhook એન્ડપોઇન્ટ્સ
દરેક એન્ડપોઇન્ટ માટેના સિક્રેટ્સ અને ઇવેન્ટ ફિલ્ટર્સ સાથે અનેક webhook URLs મેનેજ કરો.
એન્ડપોઇન્ટ-આધારિત webhook સિસ્ટમ તમને દરેક સંસ્થા માટે પોતાનું secret, પોતાની સ્થિતિ અને ઇવેન્ટ પ્રકારોના ઉપસેટ માટે પોતાનું subscription ધરાવતા બહુવિધ ગંતવ્યો નોંધવાની સુવિધા આપે છે. તમામ નવા ઇન્ટિગ્રેશન્સ માટે આ ભલામણ કરાયેલ મોડેલ છે.
લેગસી સિંગલ-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+ | તાજેતરના એન્ડપોઇન્ટ અને લેગસી ડિલિવરી પરિણામો તપાસો |
Endpoint ઑબ્જેક્ટ
{
"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 કલાકનું રીટ્રાય શેડ્યૂલ પૂર્ણ કરે ત્યારે આપમેળે સેટ થાય છે) |
agent_id | ઇન્ટિજર | 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 | ઇન્ટિજર | 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: [] સાથે સંસ્થા-વ્યાપી endpoint બનાવો. ખાલી ઇવેન્ટ યાદીને 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"Endpoint ઑબ્જેક્ટ્સ ની array પરત કરે છે.
ફક્ત તે એજન્ટ સુધી મર્યાદિત એન્ડપૉઇન્ટ્સ પરત કરવા માટે ?agent_id=42 આપો.
એજન્ટ-મર્યાદિત એન્ડપૉઇન્ટ્સ
સંસ્થા-વ્યાપી એન્ડપૉઇન્ટ્સ દરેક મેળ ખાતો ઇવેન્ટ મેળવે છે. agent_id ધરાવતો
એન્ડપૉઇન્ટ ફક્ત તે એજન્ટ દ્વારા હેન્ડલ કરાયેલા કૉલ્સ માટેના મેળ ખાતા ઇવેન્ટ્સ મેળવે છે;
alert.triggered જેવા એજન્ટ સંદર્ભ વિનાના ઇવેન્ટ્સ ક્યારેય ત્યાં પહોંચતા નથી. તમે
એજન્ટ બિલ્ડરના Webhooks વિભાગમાંથી પણ આ એન્ડપૉઇન્ટ્સ બનાવી અને મેનેજ કરી શકો છો.
એન્ડપોઇન્ટ બનાવો
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 વાપરો |
એન્ડપોઇન્ટ ઑબ્જેક્ટ સાથે 201 Created પરત કરે છે, ઉપરાંત
કાચી સાઇનિંગ કી ધરાવતું વધારાનું ટોપ-લેવલ secret ફીલ્ડ પણ પરત કરે છે — એક
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 | string | |
url | string | |
events | array | |
status | string | active અથવા disabled. સર્વરે failing તરીકે ચિહ્નિત કરેલા એન્ડપોઇન્ટને ફરી સક્રિય કરવા માટે active સેટ કરો |
agent_id | integer | null | એન્ડપોઇન્ટને મર્યાદિત કરવા માટે એજન્ટ આઇડી સેટ કરો અથવા તેને સંસ્થા-વ્યાપી બનાવવા માટે 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 ની એરે | હવે નવું સિક્રેટ વાપરતો દરેક એન્ડપોઇન્ટ |
પરીક્ષણ ડિલિવરી મોકલો
સામાન્ય ડિલિવરી પાઇપલાઇનનો ઉપયોગ કરીને એક એન્ડપોઇન્ટ પર કૃત્રિમ 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 ભૂલો પ્રમાણપત્ર ચેઇન, હોસ્ટનામ અથવા સમાપ્તિ તરફ સૂચવે છે.