Skip to main content
Glama
AdaptlyPost

AdaptlyPost

Official

List Webhooks

list_webhooks
Read-onlyIdempotent

List webhook endpoints registered for a workspace, showing whether each is active and when it last succeeded or failed, to verify delivery health before relying on post notifications.

Instructions

List the webhook endpoints registered for the workspace (the current one unless workspaceId names another), with whether each is active and when it last succeeded or failed. Needs the webhooks.read permission, which Admin, Editor and Viewer hold. Takes only the optional workspaceId.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_webhooks"
  }
}

Input Schema

NameRequiredDescriptionDefault
workspaceIdNoWorkspace to act in: an id from list_workspaces. Omit to act in the workspace list_workspaces marks current. Use the same workspaceId for every call about the same workspace, since ids from one workspace (accounts, posts, uploads) do not exist in another

Output Schema

NameRequiredDescriptionDefault
resultYesAn object with webhooks: one record per endpoint. The webhook: id, url, active, events (empty means the default post, account and image events), createdAt, updatedAt, lastSuccessAt, lastFailureAt and disabledAt (set when it was turned off after 20 failed deliveries in a row).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.22.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is covered. The description adds genuinely new behavioral context: the webhooks.read permission requirement and which roles (Admin, Editor, Viewer) satisfy it, plus the fact that health status per endpoint is surfaced. It stops short of describing pagination or ordering, which keeps it from a 5.

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

Conciseness5/5

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

Three sentences, zero filler, with the resource and default scope front-loaded before permissions and parameter scope. Each sentence carries distinct information (what is listed, what is required, what inputs exist).

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 single-parameter read tool with full annotations and an output schema, nothing an agent needs is missing: scope default, authorization requirement, and the fact that per-endpoint health is returned are all stated. Return-shape details are correctly left to the output schema.

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% and the single workspaceId parameter is documented in detail in the schema, including the list_workspaces cross-reference and id-consistency warning. The description only restates that workspaceId is optional and defaults to the current workspace, adding no syntax or meaning beyond that, so the baseline 3 applies.

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 and resource ('List the webhook endpoints registered for the workspace') plus the scope of the listing (current workspace unless workspaceId names another). It also names the fields returned (active flag, last succeeded/failed), which lets an agent distinguish this from create_webhook/delete_webhook 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 Guidelines4/5

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

Gives clear context for use: read the workspace's webhook endpoints, defaulting to the current workspace, and states the required permission along with which roles hold it. It does not explicitly name create_webhook/delete_webhook as alternatives, but the list-vs-mutate distinction is evident from the description and sibling names.

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

Deploy Server

Other Tools