Platform

Data source: Internal

REST Bridge Endpoint https://context.gnist.ai/rest/webhooks/

Authentication

All requests require a Gnist-API-Key header (or api_key query parameter).

Free tier: 100 calls/day. Get your API key.

Tools (7)

subscribe
unsubscribe
list_subscriptions
reset_subscription
list_deliveries
get_webhook_metrics
report_feedback

subscribe

Create a webhook subscription for data change notifications.

When data matching the entity_type changes, a signed POST request
will be sent to the callback_url with the change payload.

The returned secret is used to verify webhook signatures (HMAC-SHA256).
Store it securely — it is only shown once.

Args:
api_key: Your Gnist API key.
entity_type: The type of entity to monitor for changes.
callback_url: HTTPS endpoint to receive webhook deliveries.

Returns:
Subscription details including id and signing secret, or error.

Parameter	Type	Required	Description
`api_key`	`string`	required	Your Gnist API key (starts with 'gnist_').
`entity_type`	`string`	required	Entity type to subscribe to (e.g. 'brreg_company', 'doffin_tender').
`callback_url`	`string`	required	HTTPS URL where webhook events will be delivered.

Request Body

{
  "api_key": "example",
  "entity_type": "example",
  "callback_url": "example"
}

unsubscribe

Remove a webhook subscription (soft delete).

The subscription will stop receiving deliveries immediately.

Args:
api_key: Your Gnist API key.
subscription_id: The subscription UUID to deactivate.

Returns:
Confirmation or error if subscription not found.

Parameter	Type	Required	Description
`api_key`	`string`	required	Your Gnist API key (starts with 'gnist_').
`subscription_id`	`string`	required	UUID of the subscription to remove.

Request Body

{
  "api_key": "example",
  "subscription_id": "example"
}

list_subscriptions

List all active webhook subscriptions for your API key.

Returns subscriptions with their entity type, callback URL, and status.

Args:
api_key: Your Gnist API key.

Returns:
List of active subscriptions.

Parameter	Type	Required	Description
`api_key`	`string`	required	Your Gnist API key (starts with 'gnist_').

Request Body

{
  "api_key": "example"
}

reset_subscription

Reset a subscription's circuit breaker.

When a subscription has too many consecutive delivery failures,
its circuit breaker opens and deliveries are paused. Use this
tool to manually re-enable delivery.

Args:
api_key: Your Gnist API key.
subscription_id: The subscription UUID to reset.

Returns:
Confirmation or error if subscription not found.

Parameter	Type	Required	Description
`api_key`	`string`	required	Your Gnist API key (starts with 'gnist_').
`subscription_id`	`string`	required	UUID of the subscription to reset.

Request Body

{
  "api_key": "example",
  "subscription_id": "example"
}

list_deliveries

List recent webhook deliveries.

Shows delivery attempts with status (pending/delivered/failed),
number of attempts, and HTTP response codes.

Args:
api_key: Your Gnist API key.
subscription_id: Optional filter to a specific subscription.
limit: Maximum deliveries to return (1-200, default 50).

Returns:
List of recent deliveries.

Parameter	Type	Required	Description
`api_key`	`string`	required	Your Gnist API key (starts with 'gnist_').
`subscription_id`	`any`	optional	Filter to a specific subscription UUID. Omit for all subscriptions.
`limit`	`integer`	optional	Maximum number of deliveries to return. (default: 50)

Request Body

{
  "api_key": "example"
}

get_webhook_metrics

Get webhook delivery metrics.

Returns aggregated delivery statistics per subscription: total deliveries,
success/failure/pending counts, and last delivery timestamp.

Args:
api_key: Your Gnist API key.
subscription_id: Optional filter to a specific subscription.
hours: Time window in hours (1-720, default 24).

Returns:
Delivery metrics grouped by subscription.

Parameter	Type	Required	Description
`api_key`	`string`	required	Your Gnist API key (starts with 'gnist_').
`subscription_id`	`any`	optional	Filter to a specific subscription UUID. Omit for all subscriptions.
`hours`	`integer`	optional	Time window in hours (default 24, max 720). (default: 24)

Request Body

{
  "api_key": "example"
}

report_feedback

Report a bug, feature request, or general feedback for this data source.

Use this when something doesn't work as expected, when you'd like
a new feature, or when you have suggestions for improvement.

Args:
feedback: Describe the issue or suggestion.
feedback_type: One of 'bug', 'feature_request', or 'general'.

Parameter	Type	Required	Description
`feedback`	`string`	required
`feedback_type`	`string`	optional	(default: "general")

Request Body

{
  "feedback": "example"
}

Quick Start

Shell

curl -X POST "https://context.gnist.ai/rest/webhooks/subscribe" \
  -H "Content-Type: application/json" \
  -H "Gnist-API-Key: YOUR_API_KEY" \
  -d '{"api_key": "example", "entity_type": "example", "callback_url": "example"}'

Python

import httpx

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