Update a webhook

Updates one agent webhook. Use this to change the destination URL, event subscriptions, signing secret, or active state. Only supplied fields are changed; sending an empty secret clears the stored secret.

PATCH /api/v1/agents/{uuid}/webhooks/{webhookUuid}

Update a webhook

cURL

curl --request PATCH \
  --url https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/webhooks/{webhookUuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [],
  "secret_key": "<string>",
  "is_active": true
}
'

import requests

url = "https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/webhooks/{webhookUuid}"

payload = {
    "url": "<string>",
    "events": [],
    "secret_key": "<string>",
    "is_active": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>', events: [], secret_key: '<string>', is_active: true})
};

fetch('https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/webhooks/{webhookUuid}', 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://{subdomain}.mihu.ai/api/v1/agents/{uuid}/webhooks/{webhookUuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'events' => [
        
    ],
    'secret_key' => '<string>',
    'is_active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://{subdomain}.mihu.ai/api/v1/agents/{uuid}/webhooks/{webhookUuid}"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"events\": [],\n  \"secret_key\": \"<string>\",\n  \"is_active\": true\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/webhooks/{webhookUuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"events\": [],\n  \"secret_key\": \"<string>\",\n  \"is_active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/webhooks/{webhookUuid}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"events\": [],\n  \"secret_key\": \"<string>\",\n  \"is_active\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "data": {
    "webhook_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "events": [],
    "is_active": true,
    "has_secret": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Path Parameters

uuid · string<uuid> · required

webhookUuid · string<uuid> · required

Body

application/json

url · string<uri> · required

events · enum<string>[] · required

Available options: conversation_status, conversation_end_report, conversation_update, voice_evaluation, text_evaluation, intent_call

secret_key · string | null

Used to sign webhook payloads. Write-only — never returned by GET endpoints.

is_active · boolean

Response

200

application/json

Webhook updated

success · boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

data · object

Show child attributes