Skip to main content
GET
/
api
/
v2
/
webhookRelay
/
{type}
Get a webhook relay configuration
curl --request GET \
  --url 'https://api.vida.dev/api/v2/webhookRelay/{type}?token='
{
  "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
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://vida.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

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