GnistAI GnistAI
Log in

Webhook Subscriptions

Manage webhook subscriptions for push-based data delivery — subscribe to entity changes, list subscriptions, and track delivery status.

Overview   |   MCP Docs   |   API Docs   |   OpenAPI   |   Playground   |   Tutorial   |   Toolkits   |   Home
status: healthy status status healthy healthy tools: 7 tools tools 7 7 Platform

Data source: Internal

MCP MCP Protocol

Endpoint https://context.gnist.ai/mcp/webhooks/
claude_desktop_config.json
{
  "mcpServers": {
    "gnist-webhooks": {
      "url": "https://context.gnist.ai/mcp/webhooks/",
      "headers": {
        "Gnist-API-Key": "YOUR_API_KEY"
      }
    }
  }
}
Shell
curl -X POST "https://context.gnist.ai/mcp/webhooks/" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -H "Gnist-API-Key: YOUR_API_KEY" \
  -d '{"jsonrpc": "2.0", "method": "tools/call", "id": 1, "params": {"name": "subscribe", "arguments": {"api_key": "example", "entity_type": "example", "callback_url": "example"}}}'

API REST API

API Root https://context.gnist.ai/rest/webhooks/

7 endpoints available:

Shell
curl "https://context.gnist.ai/rest/webhooks/subscribe?api_key=example&entity_type=example&callback_url=example" \
  -H "Gnist-API-Key: YOUR_API_KEY"
Python
import httpx

resp = httpx.get(
    "https://context.gnist.ai/rest/webhooks/subscribe",
    headers={"Gnist-API-Key": "YOUR_API_KEY"},
    params={
        "api_key": "example",
        "entity_type": "example",
        "callback_url": "example"
},
)
print(resp.json())

OpenAPI Spec  ·  Full API Docs

CLI Command Line

Command gc webhooks

CLI documentation will be available when the GnistAI SDK is published.

Install
pip install gnistai

Available Tools (7)

subscribe
Create a webhook subscription for data change notifications.
ParameterTypeRequiredDescription
api_keystringrequiredYour Gnist API key (starts with 'gnist_').
entity_typestringrequiredEntity type to subscribe to (e.g. 'brreg_company', 'doffin_tender').
callback_urlstringrequiredHTTPS URL where webhook events will be delivered.
unsubscribe
Remove a webhook subscription (soft delete).
ParameterTypeRequiredDescription
api_keystringrequiredYour Gnist API key (starts with 'gnist_').
subscription_idstringrequiredUUID of the subscription to remove.
list_subscriptions
List all active webhook subscriptions for your API key.
ParameterTypeRequiredDescription
api_keystringrequiredYour Gnist API key (starts with 'gnist_').
reset_subscription
Reset a subscription's circuit breaker.
ParameterTypeRequiredDescription
api_keystringrequiredYour Gnist API key (starts with 'gnist_').
subscription_idstringrequiredUUID of the subscription to reset.
list_deliveries
List recent webhook deliveries.
ParameterTypeRequiredDescription
api_keystringrequiredYour Gnist API key (starts with 'gnist_').
subscription_idanyoptionalFilter to a specific subscription UUID. Omit for all subscriptions.
limitintegeroptionalMaximum number of deliveries to return. (default: 50)
get_webhook_metrics
Get webhook delivery metrics.
ParameterTypeRequiredDescription
api_keystringrequiredYour Gnist API key (starts with 'gnist_').
subscription_idanyoptionalFilter to a specific subscription UUID. Omit for all subscriptions.
hoursintegeroptionalTime window in hours (default 24, max 720). (default: 24)
report_feedback
Report a bug, feature request, or general feedback for this data source.
ParameterTypeRequiredDescription
feedbackstringrequired
feedback_typestringoptional (default: "general")

Related