result = client.webhooks.test()
print(result.data.delivered, result.data.status_code)
const result = await client.webhooks.test();
console.log(result.data?.delivered, result.data?.statusCode);
curl -X POST 'https://api.hydradb.com/webhooks/indexing/test' \
-H "Authorization: Bearer $HYDRADB_API_KEY" \
-H "API-Version: 2"
{
"data": {
"delivered": true,
"message": "Success",
"status_code": 200
},
"error": null,
"meta": {
"collection": "team_docs",
"database": "acme_corp",
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"source_type": "file",
"sub_tenant_id": "sub_tenant_4567",
"tenant_id": "tenant_1234",
"warnings": [
{
"code": "acl_ignored_by_connector_enforcement",
"message": "This connector enforces ACL, so the request's acl was ignored."
}
]
},
"success": true
}{
"data": null,
"detail": {
"deprecated": true,
"deprecated_field": "tenant_id",
"deprecated_since": "2.0.1",
"error_code": "VALIDATION_ERROR",
"message": "Request validation failed",
"preferred_field": "database",
"retry_after_seconds": 1,
"retryable": true
},
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d"
},
"success": false
}Webhooks
Send Test Delivery
Send a synthetic delivery to your registered webhook endpoint.
POST
/
webhooks
/
indexing
/
test
result = client.webhooks.test()
print(result.data.delivered, result.data.status_code)
const result = await client.webhooks.test();
console.log(result.data?.delivered, result.data?.statusCode);
curl -X POST 'https://api.hydradb.com/webhooks/indexing/test' \
-H "Authorization: Bearer $HYDRADB_API_KEY" \
-H "API-Version: 2"
{
"data": {
"delivered": true,
"message": "Success",
"status_code": 200
},
"error": null,
"meta": {
"collection": "team_docs",
"database": "acme_corp",
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"source_type": "file",
"sub_tenant_id": "sub_tenant_4567",
"tenant_id": "tenant_1234",
"warnings": [
{
"code": "acl_ignored_by_connector_enforcement",
"message": "This connector enforces ACL, so the request's acl was ignored."
}
]
},
"success": true
}{
"data": null,
"detail": {
"deprecated": true,
"deprecated_field": "tenant_id",
"deprecated_since": "2.0.1",
"error_code": "VALIDATION_ERROR",
"message": "Request validation failed",
"preferred_field": "database",
"retry_after_seconds": 1,
"retryable": true
},
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d"
},
"success": false
}Sends a synthetic
The test payload carries
indexing.status_changed delivery to your registered endpoint so you can confirm it is reachable and that your signature verification works.
result = client.webhooks.test()
print(result.data.delivered, result.data.status_code)
const result = await client.webhooks.test();
console.log(result.data?.delivered, result.data?.statusCode);
curl -X POST 'https://api.hydradb.com/webhooks/indexing/test' \
-H "Authorization: Bearer $HYDRADB_API_KEY" \
-H "API-Version: 2"
"test": true, and is signed exactly like a real delivery when a signing secret is configured. The response reports whether your endpoint accepted it (delivered) and the HTTP status_code it returned. If no webhook is registered, the call returns 404.
Test deliveries do not appear in the delivery history returned by List Deliveries.
See Read the payload you receive for the full payload shape.Authorizations
Send your API key as Authorization: Bearer <your_api_key>.
Response
OK
Show child attributes
Show child attributes
Example:
{
"delivered": true,
"message": "Success",
"status_code": 200
}
Error details on failure, or null on success.
Show child attributes
Show child attributes
Example:
null
Show child attributes
Show child attributes
Example:
{
"collection": "team_docs",
"database": "acme_corp",
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"source_type": "file",
"sub_tenant_id": "sub_tenant_4567",
"tenant_id": "tenant_1234",
"warnings": [
{
"code": "acl_ignored_by_connector_enforcement",
"message": "This connector enforces ACL, so the request's acl was ignored."
}
]
}
Whether the request succeeded.
Example:
true
Was this page helpful?