Start here
Manage webhook endpoints with an API key
Add and remove your organization’s webhook endpoints from code. This is how n8n, Zapier and your own integrations register a webhook of their own when they are switched on, and remove it when they are switched off.
When to use it
The webhooks themselves are the same whichever way an endpoint was added: the same events, the same retries, the same delivery log. Add an endpoint in the app when a person sets it up once. Use these routes when a program does it: an integration platform that registers a webhook per workflow, or your own deployment that creates its endpoint as it starts.
The four routes
The same routes are on both APIs, with the API’s own key. Both manage the one list your organization has, which is also the list in the app under Developer Tools, Webhooks.
https://api.websitescreenshotworld.com/instant-snap/v1/webhook-endpointshttps://api.websitescreenshotworld.com/instant-snap/v1/webhook-endpointshttps://api.websitescreenshotworld.com/instant-snap/v1/webhook-endpoints/{id}https://api.websitescreenshotworld.com/instant-snap/v1/webhook-endpoints/{id}- With an Instant Snap key (
wsw_api_):https://api.websitescreenshotworld.com/instant-snap/v1/webhook-endpoints, shown above. - With an Auto Schedule key (
wsw_autoapi_):https://autoapi.websitescreenshotworld.com/auto-schedule/v1/webhook-endpoints.
No update
Adding an endpoint
| Field | Type | Default | Description |
|---|---|---|---|
urlRequired | string | — | Where to post: a public https address. Addresses inside private networks are refused. |
eventsRequired | array of strings | — | One or more of capture.succeeded, capture.failed, capture.changed, delivery.completed, schedule.paused and sitemap_run.completed. |
name | string | — | What the endpoint is called in the app. Defaults to “Added through the API”. |
product | string | — | auto_schedule or instant_snap to take only that product’s events. Leave it out for both. |
web_page_id | uuid | — | One schedule’s id, to take only that schedule’s events. |
curl -X POST https://api.websitescreenshotworld.com/instant-snap/v1/webhook-endpoints \
-H "X-Api-Key: $WSW_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://hooks.example.com/wsw",
"events": ["capture.succeeded", "capture.failed"],
"name": "Production workflow"
}'The answer is 201 with the endpoint and its signing secret:
{
"success": true,
"id": "6d1c2f4e-8b7a-4c3d-9e2f-1a0b9c8d7e6f",
"name": "Production workflow",
"url": "https://hooks.example.com/wsw",
"events": ["capture.succeeded", "capture.failed"],
"product": null,
"web_page_id": null,
"is_enabled": true,
"has_own_secret": true,
"disabled_reason": null,
"last_delivery_at": null,
"last_status_code": null,
"created_at": "2026-11-14T10:02:11.000Z",
"signing_secret": "whsec_..."
}25 endpoints per organization
409 webhook_endpoint_limit_reached.The signing secret
An endpoint added through the API gets a signing secret of its own, and every delivery to it is signed with that secret, in the same X-WSW-Signature header and the same way as every other webhook.
It is shown once
signing_secret is in the create answer and nowhere else: not in the list, not in the app. Store it when you add the endpoint. If it is lost, delete the endpoint and add it again.Endpoints added in the app keep using your organization’s shared secret. Rotating that secret in the app does not affect endpoints added through the API, and an API key never reveals it.
Endpoint fields
The list (items), a read, and a create all describe an endpoint the same way:
| Field | Type | Default | Description |
|---|---|---|---|
id | uuid | — | Keep it to read or delete the endpoint later. |
name | string | — | The name shown in the app. |
url | string | — | Where deliveries are posted. |
events | array of strings | — | The events it receives. |
product | string or null | — | auto_schedule or instant_snap when limited to one product; null for both. |
web_page_id | uuid or null | — | The schedule it is limited to, or null for every schedule. |
is_enabled | boolean | — | False once it was switched off, by a person in the app or by us after 20 failed deliveries in a row. |
has_own_secret | boolean | — | True when deliveries are signed with the endpoint’s own secret (added through the API). |
disabled_reason | string or null | — | Why we switched it off, when we did. |
last_delivery_at | string or null | — | When something was last posted to it. |
last_status_code | integer or null | — | The status code of that last delivery. |
created_at | string | — | When it was added (UTC). |
Removing an endpoint
DELETE with the endpoint’s id answers { "success": true, "id": "…", "deleted": true }. Nothing more is posted to it. Its deliveries stay in the delivery log in the app.
An endpoint that keeps failing is switched off after 20 failed deliveries in a row and its owner is emailed, so an integration that disappears without deleting its endpoint does not cause deliveries for ever.
Errors
Refusals use the same envelope as the rest of each API:
| Field | Type | Default | Description |
|---|---|---|---|
api_key_invalid | 401 | — | The key is missing, wrong, revoked or expired, or belongs to the other API. |
feature_not_available | 403 | — | Adding an endpoint needs webhooks, which are in every paid plan but not the free trial. |
validation_failed | 400 | — | The URL cannot receive webhooks, no events were given, or an event or product is not known. The message says which. |
web_page_not_found | 404 | — | web_page_id is not one of your schedules. |
webhook_endpoint_not_found | 404 | — | No endpoint with this id in your organization. |
webhook_endpoint_limit_reached | 409 | — | The organization already has 25 endpoints. |
rate_limited | 429 | — | Too many requests; wait for Retry-After. |
service_unavailable | 503 | — | Try again after Retry-After. Nothing was changed. |
Did this page answer your question?
Tell us what is missing