Create a new webhook
POST https://voice.8x8.com/api/v1/subaccounts/:subAccountId/webhooks
Create a new webhook
Request
Path Parameters
subAccountId stringrequired
Possible values: >= 3 characters and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\-._&]{3,50}$
You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding.
Bodyrequired
Create webhooks params
- VCA (Voice Call Action) - Webhook Guide
- VCS (Voice Call Status) - Webhook Guide
- VSS (Voice Session Summary) - Overview | IVR | Voice Messaging | Number Masking
- VRU (Voice Recording Uploaded) - Webhook Guide
- VNU (Virtual Number Updated) - Webhook Guide
typestring
Webhook type:
Possible values: [VCS, VCA, VSS, VRU, VNU]
urlstring
URL configured for the webhook. (POST)
httpAuthHeaderstringnullable
Add authentification header.
enabledbooleannullable
enables the webhook.
Default value:
true
Request succeeded
Schema
- Array [
- ]
subAccountIdstring
countinteger
webhooks object[]
typestring
urlstring
enabledboolean
httpAuthHeaderAvailableboolean
statusCodeinteger
statusMessagestring
{
"subAccountId":"XXXX",
"count":1,
"webhooks":[
{
"type":"VCA",
"url":"https://sample.com/test",
"enabled":true,
"httpAuthHeaderAvailable":true
}
],
"statusCode":0,
"statusMessage":"ok"
}
API key not found or invalid
Resource not accessible
Resource not found
Invalid param
Schema
errorIdstring<uuid>
Example:
1aa1fc32-8e07-11ea-864e-1961d882f548
statusCodestring
Example:
1001
statusMessagestring
Example:
Invalid JSON request body
timestampstring
Example:
{}
{
"errorId":"1aa1fc32-8e07-11ea-864e-1961d882f548",
"statusCode":"1001",
"statusMessage":"Invalid JSON request body",
"timestamp":{}
}
Server error
Source: https://developer.8x8.com/connect/reference/create-a-new-webhook · 8x8 CPaaS Developer Docs. Synced for support deflection.
Please sign in to leave a comment.
0 Comments