Skip to main content
Glama

scrapewise_update_group_delivery_webhook

Idempotent
        Creates (or changes) the group's webhook: Scrapewise POSTs a signed JSON body to your https URL when the
        daily matched file is ready (FILE_READY) and when the day turns COMPLETE, PARTIAL or STALE (DAY_COMPLETE,
        DAY_PARTIAL, DAY_STALE; the body is the delivery-status document). Each state fires once per day and
        matching run. Delivery is at least once: de-duplicate on the X-Scrapewise-Delivery header; events can
        arrive out of order - keep the newest computedAt. Failed deliveries are retried after 1 m, 5 m, 30 m,
        2 h, 6 h; after many dead deliveries in a row the webhook switches itself off.

        Signature: X-Scrapewise-Signature: v1=<hex HMAC-SHA256(secret, "<X-Scrapewise-Timestamp>.<raw body>")>.
        The secret is answered ONLY by the call that creates the webhook - store it then. To change the secret:
        delete the webhook, then create it again. Changing url / events / enabled keeps the secret.

        Args:
          - id (string, path, required): the group's id (you must own the group).
          - body (object, required): {url: "https://...", events?: [FILE_READY, DAY_COMPLETE, DAY_PARTIAL,
            DAY_STALE] (default all four), enabled?: true}. The url must be https, on the public internet, at most
            2,048 characters, with no user:password.
          - customerRef (string, query, optional): admin keys in Take Over only.

        Returns:
          {url, events, enabled, createdAt, lastDeliveryAt, lastStatus, lastHttpStatus, autoDisabledAt, secret}
          - secret only when the webhook was just created.

        Examples:
          - Use when: "notify https://example.com/hooks/scrapewise when today's data for group {id} is complete".
          - Use when: switching a webhook back on after it switched itself off (enabled: true).
          - Don't use when: you only want to look at the status -> get the group delivery status.

        Error Handling:
          - 400 WEBHOOK_URL_REFUSED: not https, private / local address, unknown host, credentials in the url.
          - 400 WEBHOOK_INVALID: unknown event. 403 WEBHOOK_OWNER_ONLY: the group is shared with you.
          - 503 WEBHOOK_UNAVAILABLE: webhooks are not available on this server right now (status still works).
          - 409 TAKE_OVER_ACTIVE; 401 Unauthorized; 500 INTERNAL.

[runtime hint] This tool returns JSON-as-text — its response shape is dynamic (per-scraper itemsConfig, file binary, etc.) so the MCP outputSchema is omitted. Do not rely on the presence of any specific field in the response; treat the result as a string-or-object blob and parse defensively.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>",
      "body": "<body>"
    },
    "name": "scrapewise_update_group_delivery_webhook"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesthe group's id (you must own the group).
bodyYesThe webhook: an https URL, the events to send, on/off.
customerRefNoAdmin keys in Take Over only: the customerUniqueRef of the customer the admin works for. Required then; leave it out otherwise.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / id / description
      Added value: +"the group's id (you must own the group)."
  2. Added

TDQS

A4.6/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations (readOnlyHint=false, idempotentHint=true, destructiveHint=false) by disclosing at-least-once delivery, the X-Scrapewise-Delivery dedup header, out-of-order events with newest-computedAt wins, the retry schedule (1 m, 5 m, 30 m, 2 h, 6 h), and auto-disable after repeated dead deliveries. The HMAC signature scheme, the fact that the secret is returned ONLY on the creating call, and per-state error codes are all surfaced, and nothing conflicts with the declared annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well front-loaded and organized into behavior, signature, Args, Returns, Examples, and Error Handling, with the most decision-critical facts (at-least-once, secret shown once) early. It is on the long side and the Args block is largely redundant with an already 100%-documented schema, which keeps it off a 5.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, and the description compensates with a full returns shape including lastStatus, lastHttpStatus, autoDisabledAt and the conditional secret. Combined with the retry, signature, and error-code detail, an agent has everything needed to call this mutation correctly, including the 403 owner-only and 503 unavailability cases.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents url constraints, the four event names with their default, enabled defaulting to true, and customerRef's Take Over requirement. The Args section largely restates that schema text, adding only the nuance that the secret is returned on creation and preserved on url/events/enabled changes; baseline 3 is appropriate when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening clause states a specific verb and resource: 'Creates (or changes) the group's webhook', then immediately explains what the webhook actually does (POSTs a signed JSON body on FILE_READY / DAY_COMPLETE etc.). This is clearly distinguishable from the sibling delete, test, and status tools without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit 'Use when' examples cover both creation and re-enabling after auto-disable, and a 'Don't use when' line routes the agent to scrapewise_get_group_delivery_status for read-only status checks. It also states the secret-rotation workaround (delete then re-create) versus the in-place fields that preserve the secret, which is exactly the decision an agent needs to make.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.