Send a test delivery
curl --request POST \
--url https://api.vaquill.ai/api/v1/watches/{watch_id}/test \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vaquill.ai/api/v1/watches/{watch_id}/test"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vaquill.ai/api/v1/watches/{watch_id}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vaquill.ai/api/v1/watches/{watch_id}/test"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"channel": "webhook",
"webhook": {
"success": true,
"statusCode": 200
}
},
"meta": {
"processingTimeMs": 210.5,
"creditsConsumed": 0
}
}{
"detail": "Insufficient API credits.",
"errors": [
{
"loc": [
"body",
"query"
],
"msg": "Field required",
"type": "missing"
}
],
"code": "insufficient_credits",
"type": "https://www.vaquill.ai/docs/errors/insufficient_credits",
"title": "Insufficient credits",
"status": 402,
"requestId": "8d32789e-7b27-44f7-9523-424596e7a929",
"retryable": false,
"retryAfterSeconds": 30,
"actId": "UNKNOWN_99999",
"reason": "not_in_registry",
"didYouMean": [
"<string>"
],
"sessionLawId": "Pub. L. 117-58",
"defaultSessionLawId": "us1_ca_2019_ch_123",
"candidateCount": 3,
"truncated": false,
"jurisdictions": [
"<string>"
],
"sessionCoverage": {},
"creditsRequired": 5,
"creditsAvailable": 2,
"topUpHint": "Add credits in the developer dashboard, then retry the same request."
}{
"detail": "Insufficient API credits.",
"errors": [
{
"loc": [
"body",
"query"
],
"msg": "Field required",
"type": "missing"
}
],
"code": "insufficient_credits",
"type": "https://www.vaquill.ai/docs/errors/insufficient_credits",
"title": "Insufficient credits",
"status": 402,
"requestId": "8d32789e-7b27-44f7-9523-424596e7a929",
"retryable": false,
"retryAfterSeconds": 30,
"actId": "UNKNOWN_99999",
"reason": "not_in_registry",
"didYouMean": [
"<string>"
],
"sessionLawId": "Pub. L. 117-58",
"defaultSessionLawId": "us1_ca_2019_ch_123",
"candidateCount": 3,
"truncated": false,
"jurisdictions": [
"<string>"
],
"sessionCoverage": {},
"creditsRequired": 5,
"creditsAvailable": 2,
"topUpHint": "Add credits in the developer dashboard, then retry the same request."
}{
"detail": "Insufficient API credits.",
"errors": [
{
"loc": [
"body",
"query"
],
"msg": "Field required",
"type": "missing"
}
],
"code": "insufficient_credits",
"type": "https://www.vaquill.ai/docs/errors/insufficient_credits",
"title": "Insufficient credits",
"status": 402,
"requestId": "8d32789e-7b27-44f7-9523-424596e7a929",
"retryable": false,
"retryAfterSeconds": 30,
"actId": "UNKNOWN_99999",
"reason": "not_in_registry",
"didYouMean": [
"<string>"
],
"sessionLawId": "Pub. L. 117-58",
"defaultSessionLawId": "us1_ca_2019_ch_123",
"candidateCount": 3,
"truncated": false,
"jurisdictions": [
"<string>"
],
"sessionCoverage": {},
"creditsRequired": 5,
"creditsAvailable": 2,
"topUpHint": "Add credits in the developer dashboard, then retry the same request."
}{
"detail": "Insufficient API credits.",
"errors": [
{
"loc": [
"body",
"query"
],
"msg": "Field required",
"type": "missing"
}
],
"code": "insufficient_credits",
"type": "https://www.vaquill.ai/docs/errors/insufficient_credits",
"title": "Insufficient credits",
"status": 402,
"requestId": "8d32789e-7b27-44f7-9523-424596e7a929",
"retryable": false,
"retryAfterSeconds": 30,
"actId": "UNKNOWN_99999",
"reason": "not_in_registry",
"didYouMean": [
"<string>"
],
"sessionLawId": "Pub. L. 117-58",
"defaultSessionLawId": "us1_ca_2019_ch_123",
"candidateCount": 3,
"truncated": false,
"jurisdictions": [
"<string>"
],
"sessionCoverage": {},
"creditsRequired": 5,
"creditsAvailable": 2,
"topUpHint": "Add credits in the developer dashboard, then retry the same request."
}{
"detail": "Insufficient API credits.",
"errors": [
{
"loc": [
"body",
"query"
],
"msg": "Field required",
"type": "missing"
}
],
"code": "insufficient_credits",
"type": "https://www.vaquill.ai/docs/errors/insufficient_credits",
"title": "Insufficient credits",
"status": 402,
"requestId": "8d32789e-7b27-44f7-9523-424596e7a929",
"retryable": false,
"retryAfterSeconds": 30,
"actId": "UNKNOWN_99999",
"reason": "not_in_registry",
"didYouMean": [
"<string>"
],
"sessionLawId": "Pub. L. 117-58",
"defaultSessionLawId": "us1_ca_2019_ch_123",
"candidateCount": 3,
"truncated": false,
"jurisdictions": [
"<string>"
],
"sessionCoverage": {},
"creditsRequired": 5,
"creditsAvailable": 2,
"topUpHint": "Add credits in the developer dashboard, then retry the same request."
}Send a test delivery
Fire a one-off test delivery for a watch you own, so you can verify your webhook endpoint or email address before relying on it for real notifications. Sent with X-Vaquill-Event: board.test so your handler can tell it apart from a real board.updated event. Not persisted to delivery history and does not affect the watch’s real last-notified state. Limited to one test send per watch every 30 seconds.
Free.
POST
/
api
/
v1
/
watches
/
{watch_id}
/
test
Send a test delivery
curl --request POST \
--url https://api.vaquill.ai/api/v1/watches/{watch_id}/test \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vaquill.ai/api/v1/watches/{watch_id}/test"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vaquill.ai/api/v1/watches/{watch_id}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vaquill.ai/api/v1/watches/{watch_id}/test"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"channel": "webhook",
"webhook": {
"success": true,
"statusCode": 200
}
},
"meta": {
"processingTimeMs": 210.5,
"creditsConsumed": 0
}
}{
"detail": "Insufficient API credits.",
"errors": [
{
"loc": [
"body",
"query"
],
"msg": "Field required",
"type": "missing"
}
],
"code": "insufficient_credits",
"type": "https://www.vaquill.ai/docs/errors/insufficient_credits",
"title": "Insufficient credits",
"status": 402,
"requestId": "8d32789e-7b27-44f7-9523-424596e7a929",
"retryable": false,
"retryAfterSeconds": 30,
"actId": "UNKNOWN_99999",
"reason": "not_in_registry",
"didYouMean": [
"<string>"
],
"sessionLawId": "Pub. L. 117-58",
"defaultSessionLawId": "us1_ca_2019_ch_123",
"candidateCount": 3,
"truncated": false,
"jurisdictions": [
"<string>"
],
"sessionCoverage": {},
"creditsRequired": 5,
"creditsAvailable": 2,
"topUpHint": "Add credits in the developer dashboard, then retry the same request."
}{
"detail": "Insufficient API credits.",
"errors": [
{
"loc": [
"body",
"query"
],
"msg": "Field required",
"type": "missing"
}
],
"code": "insufficient_credits",
"type": "https://www.vaquill.ai/docs/errors/insufficient_credits",
"title": "Insufficient credits",
"status": 402,
"requestId": "8d32789e-7b27-44f7-9523-424596e7a929",
"retryable": false,
"retryAfterSeconds": 30,
"actId": "UNKNOWN_99999",
"reason": "not_in_registry",
"didYouMean": [
"<string>"
],
"sessionLawId": "Pub. L. 117-58",
"defaultSessionLawId": "us1_ca_2019_ch_123",
"candidateCount": 3,
"truncated": false,
"jurisdictions": [
"<string>"
],
"sessionCoverage": {},
"creditsRequired": 5,
"creditsAvailable": 2,
"topUpHint": "Add credits in the developer dashboard, then retry the same request."
}{
"detail": "Insufficient API credits.",
"errors": [
{
"loc": [
"body",
"query"
],
"msg": "Field required",
"type": "missing"
}
],
"code": "insufficient_credits",
"type": "https://www.vaquill.ai/docs/errors/insufficient_credits",
"title": "Insufficient credits",
"status": 402,
"requestId": "8d32789e-7b27-44f7-9523-424596e7a929",
"retryable": false,
"retryAfterSeconds": 30,
"actId": "UNKNOWN_99999",
"reason": "not_in_registry",
"didYouMean": [
"<string>"
],
"sessionLawId": "Pub. L. 117-58",
"defaultSessionLawId": "us1_ca_2019_ch_123",
"candidateCount": 3,
"truncated": false,
"jurisdictions": [
"<string>"
],
"sessionCoverage": {},
"creditsRequired": 5,
"creditsAvailable": 2,
"topUpHint": "Add credits in the developer dashboard, then retry the same request."
}{
"detail": "Insufficient API credits.",
"errors": [
{
"loc": [
"body",
"query"
],
"msg": "Field required",
"type": "missing"
}
],
"code": "insufficient_credits",
"type": "https://www.vaquill.ai/docs/errors/insufficient_credits",
"title": "Insufficient credits",
"status": 402,
"requestId": "8d32789e-7b27-44f7-9523-424596e7a929",
"retryable": false,
"retryAfterSeconds": 30,
"actId": "UNKNOWN_99999",
"reason": "not_in_registry",
"didYouMean": [
"<string>"
],
"sessionLawId": "Pub. L. 117-58",
"defaultSessionLawId": "us1_ca_2019_ch_123",
"candidateCount": 3,
"truncated": false,
"jurisdictions": [
"<string>"
],
"sessionCoverage": {},
"creditsRequired": 5,
"creditsAvailable": 2,
"topUpHint": "Add credits in the developer dashboard, then retry the same request."
}{
"detail": "Insufficient API credits.",
"errors": [
{
"loc": [
"body",
"query"
],
"msg": "Field required",
"type": "missing"
}
],
"code": "insufficient_credits",
"type": "https://www.vaquill.ai/docs/errors/insufficient_credits",
"title": "Insufficient credits",
"status": 402,
"requestId": "8d32789e-7b27-44f7-9523-424596e7a929",
"retryable": false,
"retryAfterSeconds": 30,
"actId": "UNKNOWN_99999",
"reason": "not_in_registry",
"didYouMean": [
"<string>"
],
"sessionLawId": "Pub. L. 117-58",
"defaultSessionLawId": "us1_ca_2019_ch_123",
"candidateCount": 3,
"truncated": false,
"jurisdictions": [
"<string>"
],
"sessionCoverage": {},
"creditsRequired": 5,
"creditsAvailable": 2,
"topUpHint": "Add credits in the developer dashboard, then retry the same request."
}Authorizations
ApiKeyAuthApiKeyHeader
Was this page helpful?

