GET
/
api
/
v2
/
webhookRelay
/
{type}
Get a webhook relay configuration
curl --request GET \
  --url https://api.vida.dev/api/v2/webhookRelay/{type}
{
  "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

​
token
string
query
required

Vida API Token

Path Parameters

​
type
string
required

Relay type to fetch (must match one of GET /webhookRelay/types)

Response

Relay configuration found

​
success
boolean
Example:

true

​
message
string
Example:

"Webhook Relay configuration fetched successfully."

​
config
object