client.webhooks.clear_signing_secret()
await client.webhooks.clearSigningSecret();
curl -X DELETE 'https://api.hydradb.com/webhooks/indexing/signing-secret' \
-H "Authorization: Bearer $HYDRA_DB_API_KEY" \
-H "API-Version: 2"
{
"data": {
"event_types": [
"indexing.status_changed"
],
"message": "Success",
"registered": true,
"signing_secret": "whsec_EXAMPLE_ONLY_THIS_IS_NOT_A_REAL_SIGNING_KEY",
"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": "team_docs",
"tenant_id": "acme_corp"
},
"success": true
}{
"data": "<unknown>",
"detail": {
"deprecated": true,
"deprecated_field": "tenant_id",
"error_code": "VALIDATION_ERROR",
"message": "Request validation failed",
"preferred_field": "database"
},
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d"
},
"success": false
}Webhooks
Disable Signing
Remove the signing secret while keeping the webhook registered.
DELETE
/
webhooks
/
indexing
/
signing-secret
client.webhooks.clear_signing_secret()
await client.webhooks.clearSigningSecret();
curl -X DELETE 'https://api.hydradb.com/webhooks/indexing/signing-secret' \
-H "Authorization: Bearer $HYDRA_DB_API_KEY" \
-H "API-Version: 2"
{
"data": {
"event_types": [
"indexing.status_changed"
],
"message": "Success",
"registered": true,
"signing_secret": "whsec_EXAMPLE_ONLY_THIS_IS_NOT_A_REAL_SIGNING_KEY",
"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": "team_docs",
"tenant_id": "acme_corp"
},
"success": true
}{
"data": "<unknown>",
"detail": {
"deprecated": true,
"deprecated_field": "tenant_id",
"error_code": "VALIDATION_ERROR",
"message": "Request validation failed",
"preferred_field": "database"
},
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d"
},
"success": false
}Removes the stored secret. The webhook stays registered and continues receiving deliveries, but new deliveries no longer carry
Editing the webhook registration preserves its signing secret. Use this endpoint to disable signing, or Delete Webhook to stop deliveries entirely.
X-HydraDB-Signature. If no webhook is registered, this endpoint returns 404.
Without signing, your receiver cannot use the HydraDB signature to verify a delivery. Update your receiver’s verification policy before disabling signing.
client.webhooks.clear_signing_secret()
await client.webhooks.clearSigningSecret();
curl -X DELETE 'https://api.hydradb.com/webhooks/indexing/signing-secret' \
-H "Authorization: Bearer $HYDRA_DB_API_KEY" \
-H "API-Version: 2"
Related resources
- Set Signing Secret: enable signing again
- Get Webhook: read the signing status
Authorizations
API key sent as a Bearer token: "Bearer prefix.secret"
Response
OK
Show child attributes
Show child attributes
Example:
{
"event_types": ["indexing.status_changed"],
"message": "Success",
"registered": true,
"signing_secret": "whsec_EXAMPLE_ONLY_THIS_IS_NOT_A_REAL_SIGNING_KEY",
"signing_secret_configured": true,
"url": "https://docs.hydradb.com/phoenix"
}
Null on success; an object with code and message on failure.
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": "team_docs",
"tenant_id": "acme_corp"
}
Whether the request succeeded.
Example:
true
Was this page helpful?