Get the registered webhook for this API key
import requests
url = "https://api.hydradb.com/webhooks/indexing"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hydradb.com/webhooks/indexing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://api.hydradb.com/webhooks/indexing \
--header 'Authorization: Bearer <token>'{
"data": {
"event_types": [
"indexing.status_changed"
],
"registered": true,
"signing_secret_configured": true,
"url": "https://docs.hydradb.com/phoenix"
},
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"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"
},
"success": true
}Webhooks
Get Webhook
Retrieve the current webhook registration for your workspace.
GET
/
webhooks
/
indexing
Get the registered webhook for this API key
import requests
url = "https://api.hydradb.com/webhooks/indexing"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hydradb.com/webhooks/indexing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://api.hydradb.com/webhooks/indexing \
--header 'Authorization: Bearer <token>'{
"data": {
"event_types": [
"indexing.status_changed"
],
"registered": true,
"signing_secret_configured": true,
"url": "https://docs.hydradb.com/phoenix"
},
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"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"
},
"success": true
}Returns the registered endpoint, the subscribed event types, and whether a signing secret is configured.
When no webhook is registered,
The signing secret itself is never returned.
signing_secret_configured tells you only whether one is set. If you have lost your secret, rotate it with POST /webhooks/indexing/signing-secret rather than trying to read it back.registered is false and url is null. See Webhooks.Authorizations
API key sent as a Bearer token: "Bearer prefix.secret"
Response
200 - application/json
OK
Show child attributes
Show child attributes
Example:
{
"event_types": ["indexing.status_changed"],
"registered": true,
"signing_secret_configured": true,
"url": "https://docs.hydradb.com/phoenix"
}
Error message, empty string on success.
Show child attributes
Show child attributes
Example:
{
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
}
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"
}
Whether the request succeeded.
Example:
true
Was this page helpful?
