API Documentation
Authorization
Agents
Phone Numbers
SIP
Messaging
Webhooks
Knowledge
Accounts
- POSTCreate a new reseller
- GETList resellers
- POSTCreate a new organization
- DELDelete an organization
- GETList organizations
- GETList agent accounts
- POSTCreate a new account
- DELDelete an account
- GETList admin users
- DELDelete admin user
- POSTInvite admin user
- GETFetch Account by externalAccountId
- POSTUpdate Organization Settings
Billing
Webhooks
Get a webhook relay configuration
Fetch the current webhook relay settings for the given type (e.g., Twilio SMS, Chargebee) for your account.
GET
/
api
/
v2
/
webhookRelay
/
{type}
Copy
Ask AI
curl --request GET \
--url https://api.vida.dev/api/v2/webhookRelay/{type}
Copy
Ask AI
{
"success": true,
"message": "Webhook Relay configuration fetched successfully.",
"config": {
"url": "https://hooks.myapp.com/inbound/twilio",
"timeout": 5000,
"headers": [
{
"Authorization": "Bearer xyz"
}
],
"successStatusCodes": [
200,
202
]
}
}
Authorizations
Vida API Token
Path Parameters
Relay type to fetch (must match one of GET /webhookRelay/types)
Response
200
application/json
Relay configuration found
The response is of type object
.
Copy
Ask AI
curl --request GET \
--url https://api.vida.dev/api/v2/webhookRelay/{type}
Copy
Ask AI
{
"success": true,
"message": "Webhook Relay configuration fetched successfully.",
"config": {
"url": "https://hooks.myapp.com/inbound/twilio",
"timeout": 5000,
"headers": [
{
"Authorization": "Bearer xyz"
}
],
"successStatusCodes": [
200,
202
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.