Skip to main content
Glama

x_api_create_webhooks

Set up a webhook on X to receive automatic event notifications. Provide scoped credentials and authorization to activate the endpoint.

Instructions

Create webhook. Use when: Create 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: mutating, high-risk. Required permissions and prerequisites: bearer token; OAuth 1a user 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; body is used for the documented request payload. 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_upsert_principal_credentials, x_api_request. Safety warnings: This mutates X state. Validate scope, payload, and authorizationKey before use. Example: {"name":"x_api_create_webhooks","arguments":{"scopeTenantId":"default","scopeUserId":"default","body":{}}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNo
scopeUserIdNo
credentialKeyNo
scopeTenantIdNo
scopeAccountIdNo
authorizationKeyNo
preferredAuthTypeNo
Behavior5/5

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

No annotations are provided, so the description is the sole source for behavioral disclosure. It thoroughly covers mutating risk, required permissions (bearer token, OAuth 1a user token), environment-selection behavior (scopeTenantId plus exactly one of scopeUserId/scopeAccountId), expected response shape, and common failure conditions, exceeding typical descriptions.

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?

The description is longer than average but well-structured with labeled sections. It's front-loaded with 'Create webhook.' Some redundancy exists (e.g., 'Use when: Create webhook' repeats the first line), but every other sentence provides valuable context. The format aids scanning.

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?

Given 7 parameters, no output schema, and no annotations, the description provides extensive context: response shape, auth prerequisites, failure conditions, safety warnings, and an example invocation. This is sufficient for an agent to correctly invoke the tool in most scenarios.

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?

The schema has 7 parameters with 0% description coverage, so the description must compensate. It explains the roles of scopeTenantId, scopeUserId, scopeAccountId, credentialKey, and body, including the requirement of exactly one user/account scope. However, authorizationKey and preferredAuthType are not explained beyond a validation mention, so compensation is incomplete.

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

Purpose4/5

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

The description opens with 'Create webhook,' which clearly identifies the action and resource. However, it doesn't distinguish among sibling tools like x_api_create_webhook_replay_job or x_api_create_webhooks_stream_link, so it lacks sibling differentiation.

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?

The description includes explicit 'Use when' and 'Do not use when' conditions, and suggests x_schema_discovery and x_query_suggestion for exploration. It also lists recommended prerequisite and follow-up tools, giving clear guidance on when to use this tool versus alternatives.

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