Skip to main content
POST
/
v0
/
webhook
Create or update webhook configuration for an application
curl --request POST \
  --url https://api.avidoai.com/v0/webhook \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "url": "https://example.com/webhook",
  "headers": {
    "Authorization": "Bearer my-secret-token"
  }
}
'
import requests

url = "https://api.avidoai.com/v0/webhook"

payload = {
"url": "https://example.com/webhook",
"headers": { "Authorization": "Bearer my-secret-token" }
}
headers = {
"x-api-key": "<api-key>",
"x-application-id": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-application-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
url: 'https://example.com/webhook',
headers: {Authorization: 'Bearer my-secret-token'}
})
};

fetch('https://api.avidoai.com/v0/webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.avidoai.com/v0/webhook",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://example.com/webhook',
'headers' => [
'Authorization' => 'Bearer my-secret-token'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-application-id: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.avidoai.com/v0/webhook"

payload := strings.NewReader("{\n \"url\": \"https://example.com/webhook\",\n \"headers\": {\n \"Authorization\": \"Bearer my-secret-token\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-application-id", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.avidoai.com/v0/webhook")
.header("x-api-key", "<api-key>")
.header("x-application-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com/webhook\",\n \"headers\": {\n \"Authorization\": \"Bearer my-secret-token\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.avidoai.com/v0/webhook")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-application-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://example.com/webhook\",\n \"headers\": {\n \"Authorization\": \"Bearer my-secret-token\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "url": "https://example.com/webhook",
    "webhookSecret": "whsec_1234567890abcdef",
    "applicationId": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "modifiedAt": "2024-01-01T00:00:00.000Z",
    "orgId": "123e4567-e89b-12d3-a456-426614174000",
    "headers": {
      "Authorization": "Bearer my-secret-token"
    }
  }
}
{
"message": "Resource not found"
}
{
"message": "Resource not found"
}
{
"message": "Resource not found"
}
{
"message": "Resource not found"
}
{
"message": "Invalid request data",
"issues": [
{
"code": "invalid_string",
"message": "Invalid UUID",
"path": [
"id"
]
}
]
}
{
"message": "Resource not found"
}

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request payload for creating or updating a webhook

url
string
required

The URL where webhook events will be sent. Must be https and resolve to a public host.

Required string length: 1 - 2048
Example:

"https://example.com/webhook"

headers
WebhookHeaders · object | null

Custom authentication headers to include in webhook requests. Set to null to remove all headers.

Example:
{ "Authorization": "Bearer my-secret-token" }

Response

Webhook configuration created or updated successfully

Response containing the upserted webhook configuration

data
Webhook · object
required

The created or updated webhook configuration