Skip to main content
Glama

x_api_get_webhooks

Retrieve webhook configuration from X API, including method, path, URL, and auth type, using scoped tenant credentials.

Instructions

Get webhook. Use when: Get webhook. Do not use when: a more specific auth/configuration tool is required before the API call or you are only exploring; prefer x_schema_discovery or x_query_suggestion first. Risk: read-only. Required permissions and prerequisites: bearer token Environment-selection behavior: scopeTenantId plus exactly one of scopeUserId or scopeAccountId choose the Vault/Postgres tenant principal used for auth resolution. credentialKey selects a non-default stored credential profile when present. Parameter formats and constraints: no endpoint-specific parameters. Expected response shape: { ok, status, data: { method, path, url, status, contentType, authType, data } } Common failure conditions: missing scoped credentials in Vault, missing required API parameters, X API auth failures, rate limits, or unsupported multipart/body shape. Recommended prerequisite and follow-up tools: x_connection_info, x_schema_discovery, x_auth_get_scope_credentials, x_api_request. Safety warnings: This is read-only, but responses can still include sensitive account data depending on granted scopes. Example: {"name":"x_api_get_webhooks","arguments":{"scopeTenantId":"default","scopeUserId":"default"}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scopeUserIdNo
credentialKeyNo
scopeTenantIdNo
scopeAccountIdNo
authorizationKeyNo
preferredAuthTypeNo
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It explicitly states the tool is read-only, requires a bearer token, explains environment-selection behavior for scoped credentials, provides an expected response shape, lists common failure conditions, and includes a safety warning about sensitive data.

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

Conciseness3/5

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

The description is well-structured with labeled sections and an example. However, the opening 'Use when: Get webhook' is a redundant tautology, and some sections contain generic boilerplate that could apply to any x_api_* tool.

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

Completeness3/5

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

The description provides strong operational context: response shape, failure conditions, auth, and an example. However, it fails to explain what a webhook is, whether the response contains a single webhook or a list, or what domain-specific fields the data will include. Since there is no output schema, this missing semantic detail leaves a significant gap.

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?

With 0% schema description coverage, the description meaningfully compensates by explaining that scopeTenantId plus exactly one of scopeUserId or scopeAccountId selects the tenant principal, and that credentialKey selects a non-default credential profile. It also notes there are no endpoint-specific parameters, though it leaves authorizationKey and preferredAuthType implicit.

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

Purpose2/5

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

The description opens with 'Get webhook,' which simply restates the tool name and provides no additional meaning. It does not specify whether this retrieves a single webhook or lists all webhooks, nor does it distinguish itself from sibling webhook tools like x_api_get_webhooks_stream_links.

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

Usage Guidelines2/5

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

The 'Use when' section is circular ('Get webhook') and gives no practical guidance. The 'Do not use when' condition is generic—applying to exploration or auth prerequisites—rather than explaining when to choose a sibling tool or an alternative for webhook retrieval.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/LesterAJohn/X-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server