Skip to main content
Glama

x_api_create_webhook_replay_job

Create a webhook replay job to redeliver missed events to a specified endpoint. Use tenant-scoped credentials and a custom request body to initiate the replay.

Instructions

Create replay job for webhook. Use when: Create replay job for 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 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_webhook_replay_job","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, but the description fully carries the burden: it explicitly flags the operation as mutating and high-risk, requires bearer token, details environment-selection behavior, expected response shape, common failure conditions, and safety warnings. This is exemplary transparency for a mutation tool.

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 well-structured with labeled sections and front-loaded purpose, but contains redundancy (e.g., 'Use when' repeats the first sentence; risk is mentioned twice). It is dense and useful, though not every sentence earns its place.

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 no output schema, no annotations, and 7 parameters with 0% schema coverage, the description provides a surprising amount of context: response shape, failure conditions, prerequisites, safety, environment behavior, and an example. This makes the tool actionable despite the opaque body parameter.

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 description coverage is 0%, so the description compensates by explaining the scope parameter relationship (scopeTenantId plus exactly one of scopeUserId/scopeAccountId), credentialKey's role, and body usage. It does not explicitly explain preferredAuthType or authorizationKey details, leaving a small gap.

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 description opens with 'Create replay job for webhook,' which is a specific verb+resource statement that clearly distinguishes this tool from siblings like x_api_create_webhooks and x_api_create_webhooks_stream_link. The resource 'replay job' is unique and unambiguous.

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?

The 'Do not use when' section provides explicit exclusions and names alternative tools (x_schema_discovery, x_query_suggestion) for exploration or auth/configuration tasks. However, the 'Use when' line simply repeats the purpose rather than giving a substantive usage condition, which prevents a perfect score.

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