Pause webhook
curl --request POST \
--url https://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause \
--header 'x-api-key: <api-key>'import requests
url = "https://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause', 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://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-api-key: <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"
"net/http"
"io"
)
func main() {
url := "https://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "66f1c3b7e4b0a1b2c3d4e5f7",
"agent_id": "66e9b0f2a1c3d4e5f6a7b8c9",
"user_id": "user@example.com",
"webhook_url": "https://scheduler.studio.lyzr.ai/webhook-trigger/66f1c3b7e4b0a1b2c3d4e5f7",
"secret_key": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "New Zendesk ticket",
"is_active": true,
"updated_at": "2023-11-07T05:31:56Z",
"last_triggered_at": "2023-11-07T05:31:56Z",
"last_trigger_success": true,
"trigger_count": 0
}Agent Webhooks
Pause Webhook
Stop a webhook from triggering its agent without deleting it.
POST
/
agent-webhooks
/
{webhook_id}
/
pause
Pause webhook
curl --request POST \
--url https://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause \
--header 'x-api-key: <api-key>'import requests
url = "https://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause', 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://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-api-key: <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"
"net/http"
"io"
)
func main() {
url := "https://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://scheduler.studio.lyzr.ai/agent-webhooks/{webhook_id}/pause")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "66f1c3b7e4b0a1b2c3d4e5f7",
"agent_id": "66e9b0f2a1c3d4e5f6a7b8c9",
"user_id": "user@example.com",
"webhook_url": "https://scheduler.studio.lyzr.ai/webhook-trigger/66f1c3b7e4b0a1b2c3d4e5f7",
"secret_key": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "New Zendesk ticket",
"is_active": true,
"updated_at": "2023-11-07T05:31:56Z",
"last_triggered_at": "2023-11-07T05:31:56Z",
"last_trigger_success": true,
"trigger_count": 0
}The webhook keeps its URL and secret, so callers don’t need to be reconfigured when you call Resume Webhook.
Authorizations
Lyzr API key. Required on every endpoint except Trigger Webhook.
Path Parameters
ID of the webhook.
Example:
"66f1c3b7e4b0a1b2c3d4e5f7"
Response
The paused webhook.
Unique webhook ID.
Example:
"66f1c3b7e4b0a1b2c3d4e5f7"
Example:
"66e9b0f2a1c3d4e5f6a7b8c9"
Example:
"user@example.com"
Public URL external services call to trigger the agent.
Example:
"https://scheduler.studio.lyzr.ai/webhook-trigger/66f1c3b7e4b0a1b2c3d4e5f7"
Secret used to sign requests to webhook_url with HMAC-SHA256. Store it securely.
Example:
"New Zendesk ticket"
false when the webhook is paused.
Total number of times the webhook has been triggered.