Skip to main content
POST
Create or update a webhook relay

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:
successStatusCodes
integer[]

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

Example:

Response

Relay stored

success
boolean
Example:

true

message
string
Example:

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