Skip to main content
POST
/
api
/
v2
/
webhookRelay
/
{type}
Create or update a webhook relay
curl --request POST \
  --url 'https://api.vida.dev/api/v2/webhookRelay/{type}?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhook/twilio",
  "timeout": 5000,
  "headers": [
    {
      "Authorization": "Bearer xyz"
    },
    {
      "X-Customer-ID": "abc123"
    }
  ],
  "successStatusCodes": [
    200,
    201,
    202
  ]
}
'
{
  "success": true,
  "message": "Webhook Relay for type 'twilioSMS' configured successfully."
}

Authorizations

​
token
string
query
required

Vida API Token

Path Parameters

​
type
object
required

Relay type (e.g. twilioSMS, chargebee)

Body

application/json
​
url
string<uri>
required

Absolute HTTP/HTTPS endpoint that will receive the forwarded webhook.

Example:

"https://example.com/webhook/twilio"

​
timeout
number

Timeout (ms) before the forward request is aborted.

Example:

5000

​
headers
object[]

Custom HTTP headers (array of single-key objects).

Example:
[
  { "Authorization": "Bearer xyz" },
  { "X-Customer-ID": "abc123" }
]
​
successStatusCodes
integer[]

Status codes treated as success by Vida when your endpoint responds.

Example:
[200, 201, 202]

Response

Relay stored

​
success
boolean
Example:

true

​
message
string
Example:

"Webhook Relay for type 'twilioSMS' configured successfully."