Skip to main content
Glama

configure_payment_webhook

Idempotent

Generate a ready-to-paste payment or order webhook URL for supported gateways and stores, or trigger a test event to verify Live Activity Toast and Web Push delivery.

Instructions

Generate the ready-to-paste Automated Payment & Order Webhook URL (POST /api/v1/apps/{app_id}/incoming-event) for Midtrans, Xendit, Mayar, Lynk.id, Duitku, Tripay, WooCommerce, and GitHub, or trigger a live test payment/order event when simulate_test=true. Use this tool when connecting a payment gateway or e-commerce store to automatically show a Live Activity Toast and/or broadcast a Web Push notification upon payment settlement; do not use it for RSS blog feeds (use configure_rss_autopush instead) or manual push campaigns (use send_push_notification instead). Prerequisite: call list_apps first to obtain app_id. Requires PUSHNOTIF_API_KEY; generating the webhook URL costs 0 credits, while live or simulated push broadcasts deduct 1 credit per delivered device (toast_only mode costs 0 credits on display). Returns JSON { ok, app_id, mode, webhook_url, supported_platforms, setup_guides, simulation_result }.

Input Schema

NameRequiredDescriptionDefault
modeNoAction when payment/order event arrives: 'both' (default: show Live Activity Toast on website + send Web Push), 'toast_only' (show Live Activity Toast only, 0 credits), or 'push_only' (send Web Push notification only)
app_idYesTarget application ID in format app_xxxx (obtain from list_apps)
platformNoPlatform format to simulate when simulate_test=true: 'midtrans' (default), 'xendit', 'woocommerce', or 'github'
item_nameNoOptional custom product/order name for test simulation (default: 'Paket Premium Rp 149.000')
buyer_nameNoOptional custom buyer name for test simulation (default: 'Budi (Jakarta)')
simulate_testNoSet true to immediately fire a test payment/order webhook event to verify Live Activity Toast and Web Push delivery

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.2.0

TDQS

A4.8/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing auth requirements (PUSHNOTIF_API_KEY), the exact cost model (URL generation 0 credits, 1 credit per delivered device for live/simulated broadcasts, toast_only 0 credits), and the response envelope. This is important because annotations mark the tool non-read-only and idempotent but say nothing about side effects or billing.

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?

Front-loaded with the core action and endpoint, then usage, exclusions, prerequisites, costs, and return shape in a logical order. It is dense — the opening sentence carries an eight-item platform list and two modes — but nearly every clause adds decision-relevant information, with little redundancy.

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?

For a six-parameter mutation tool with a simulated-write path, the description covers everything an agent needs: prerequisite resolution of app_id, auth, cost implications per mode, exclusions to sibling tools, and the returned JSON keys (which substitute for the absent output schema). Nothing material is left unspecified.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds real value by tying credit cost to the mode parameter (toast_only costs 0 credits) and by restating app_id's provenance from list_apps. It does not, however, explain how platform and simulate_test interact in the description beyond the schema's own wording.

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?

States a specific verb+resource ("Generate the ready-to-paste Automated Payment & Order Webhook URL") with the exact endpoint path, and lists both operating modes (URL generation vs. simulate_test=true firing a live event). It also names the eight supported platforms, so the agent knows precisely what it produces and for whom.

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 affirmative case ("Use this tool when connecting a payment gateway or e-commerce store...") plus two named exclusions routing to siblings: configure_rss_autopush for feeds and send_push_notification for manual campaigns. It also states the prerequisite, call list_apps first to obtain app_id, which prevents the most likely invocation error.

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