webhook = client.webhooks.get()
const webhook = await client.webhooks.get();
curl 'https://api.hydradb.com/webhooks/indexing' \
-H "Authorization: Bearer $HYDRADB_API_KEY" \
-H "API-Version: 2"
{
"data": {
"event_types": [
"indexing.status_changed"
],
"registered": true,
"signing_secret_configured": true,
"url": "https://docs.hydradb.com/phoenix"
},
"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
}Webhooks
Get Webhook
Read the current webhook registration for your organization.
GET
/
webhooks
/
indexing
webhook = client.webhooks.get()
const webhook = await client.webhooks.get();
curl 'https://api.hydradb.com/webhooks/indexing' \
-H "Authorization: Bearer $HYDRADB_API_KEY" \
-H "API-Version: 2"
{
"data": {
"event_types": [
"indexing.status_changed"
],
"registered": true,
"signing_secret_configured": true,
"url": "https://docs.hydradb.com/phoenix"
},
"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
}Returns the registered endpoint, the subscribed event types, and whether a signing secret is configured.
The signing secret itself is never returned.
webhook = client.webhooks.get()
const webhook = await client.webhooks.get();
curl 'https://api.hydradb.com/webhooks/indexing' \
-H "Authorization: Bearer $HYDRADB_API_KEY" \
-H "API-Version: 2"
signing_secret_configured tells you only whether one is set. If you have lost your signing secret, rotate it with Set Signing Secret instead of trying to read it back.
When no webhook is registered, registered is false and url is null. See Webhooks.Authorizations
Send your API key as Authorization: Bearer <your_api_key>.
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 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?