Skip to main content
Glama

Create webhook

create_webhook
Destructive

Registers a webhook endpoint to receive Bannerbear event notifications for image, batch, tool job, workflow run, or animation completions and failures.

Instructions

POST /v5/webhooks. Current Bannerbear V5 operation; provider scopes, locks and credits apply. Mandatory confirmation before provider execution; one submission only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountNoExact private workspace profile label; no fallback to another profile key.
confirmNoMust be true for this exact requested render, upload, edit, install or delete.
payloadNoComplete current native JSON body. Use payload or payload_file exclusively.
payload_fileNoRegular non-symlink local JSON file, at most 1 MiB.
secret_result_fileYesNew absolute JSON file in an existing private directory; exclusive 0600 creation before the API request. No overwrite; signing key never appears in output.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.1/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=false and openWorldHint=true, but the description adds genuinely new behavioral context: provider scopes, locks and credit consumption apply, a confirmation gate precedes execution, and only one submission is accepted (reinforcing the non-idempotent profile). What actually gets destroyed and the return/error surface remain undisclosed.

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?

Three short clauses, front-loaded with the endpoint and followed by constraints; no filler. It is efficient, though the jargon-heavy phrasing trades clarity for brevity.

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?

With no output schema, the description should carry more of the return/behavior burden for a destructive create with file-writing side effects. It covers credits and confirmation but leaves the response format and secret-file semantics entirely to the schema and annotations, which happen to be rich enough to keep this adequate.

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%, so the schema already documents account, confirm, payload vs payload_file and secret_result_file in detail. The description adds no parameter-level syntax or meaning beyond the passing reference to confirmation, so the baseline 3 applies.

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

Purpose3/5

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

The description opens with "POST /v5/webhooks", which conveys the resource and operation only to a reader who knows POST implies creation; there is no plain-language verb+resource statement. It does not distinguish this tool from siblings like update_webhook or delete_webhook beyond what the name already implies.

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?

There is no guidance on when to choose this over update_webhook or the other webhook siblings. The "mandatory confirmation" and "one submission only" clauses are invocation constraints, not when-to-use/alternative routing.

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