Webhooks
Update a Webhook
Partially update a webhook subscription.
Coming soon
This endpoint is documented but not yet available in production. The contract below reflects the planned behavior. Reach out via support for early access or launch notification.
PATCH /v1/webhooks/{webhook_id} partially updates a webhook. You can change the callback URL, description, event type, or is_active flag.
Use this endpoint to pause delivery during receiver maintenance, move callbacks to a new URL, or retarget a webhook to a different completion event.
Request
The example below pauses a webhook and updates its description.
export SCRAPER_API_BASE_URL="https://scraper.geonode.io"
export GEONODE_SCRAPER_API_KEY="YOUR_API_KEY"
curl -X PATCH "$SCRAPER_API_BASE_URL/v1/webhooks/2a936d3b-5a5d-47a0-b68d-5df0d8b8327c" \
-H "X-Api-Key: $GEONODE_SCRAPER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"is_active": false,
"description": "Paused during receiver maintenance"
}'Request Body
All fields are optional. Send only the fields you want to change.
| Field | Type | Required | Description |
|---|---|---|---|
url | string or null | No | New absolute callback URL. |
description | string or null | No | New description. |
is_active | boolean or null | No | Enables or disables delivery for the webhook. |
event_type | string or null | No | New event type: extract_completed, batch_completed, or crawl_completed. |
Response
The response is the updated webhook object.
{
"id": "2a936d3b-5a5d-47a0-b68d-5df0d8b8327c",
"url": "https://example.com/webhooks/geonode-scraper",
"description": "Paused during receiver maintenance",
"is_active": false,
"event_type": "batch_completed",
"created_at": "2026-05-27T08:15:30Z",
"updated_at": "2026-05-27T08:20:00Z"
}