{"openapi":"3.1.0","info":{"title":"Hookdeck (BYOK) API","version":"0.1.0","description":"Hookdeck (BYOK) lets an AI assistant read your own Hookdeck data through the Hookdeck API with a key you supply (Hookdeck project API key). Read-only: 10 tools (list_connections, list_sources, list_destinations, list_events, get_event, list_requests, list_attempts, list_issues, count_issues, list_transformations). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-hookdeck.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-hookdeck/docs"},"termsOfService":"https://connectorbay.com/byok-hookdeck/terms"},"servers":[{"url":"https://byok-hookdeck.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-hookdeck/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_connections":{"post":{"operationId":"list_connections","summary":"List Hookdeck connections (routes from a source to a destination) with names, source, destination and paused or disabled","description":"List Hookdeck connections (routes from a source to a destination) with names, source, destination and paused or disabled state. Use for \"Which Hookdeck connections do I have and are any paused\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only connections with exactly this name.","title":"Name"},"source_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only connections from this source id.","title":"Source Id"},"destination_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only connections to this destination id.","title":"Destination Id"},"disabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for disabled connections only, false for enabled only.","title":"Disabled"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return (1 to 250; the API default is 100).","title":"Limit"},"next":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from pagination.next of the previous answer, to get the following page.","title":"Next"},"dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (oldest first) or desc (newest first, the default).","title":"Dir"}},"title":"list_connectionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_sources":{"post":{"operationId":"list_sources","summary":"List Hookdeck sources (where webhooks come in) with name, type, ingest URL, authenticated flag and disabled state. Use f","description":"List Hookdeck sources (where webhooks come in) with name, type, ingest URL, authenticated flag and disabled state. Use for \"What webhook sources are set up in Hookdeck\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only sources with exactly this name.","title":"Name"},"disabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for disabled sources only, false for enabled only.","title":"Disabled"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return (1 to 250; the API default is 100).","title":"Limit"},"next":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from pagination.next of the previous answer, to get the following page.","title":"Next"},"dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (oldest first) or desc (newest first, the default).","title":"Dir"}},"title":"list_sourcesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_destinations":{"post":{"operationId":"list_destinations","summary":"List Hookdeck destinations (where events are delivered) with name, type and disabled state. Use for \"Where does Hookdeck","description":"List Hookdeck destinations (where events are delivered) with name, type and disabled state. Use for \"Where does Hookdeck deliver my webhooks\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only destinations with exactly this name.","title":"Name"},"type":{"anyOf":[{"enum":["HTTP","CLI","MOCK_API"],"type":"string"},{"type":"null"}],"default":null,"description":"Destination type: HTTP, CLI or MOCK_API.","title":"Type"},"disabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for disabled destinations only, false for enabled only.","title":"Disabled"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return (1 to 250; the API default is 100).","title":"Limit"},"next":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from pagination.next of the previous answer, to get the following page.","title":"Next"},"dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (oldest first) or desc (newest first, the default).","title":"Dir"}},"title":"list_destinationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_events":{"post":{"operationId":"list_events","summary":"List Hookdeck events (one webhook routed to one destination) with delivery status, attempts, response status and error c","description":"List Hookdeck events (one webhook routed to one destination) with delivery status, attempts, response status and error code. Payloads are not included. Use for \"Which Hookdeck events failed recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["SCHEDULED","QUEUED","HOLD","SUCCESSFUL","FAILED","CANCELLED"],"type":"string"},{"type":"null"}],"default":null,"description":"Delivery status of the event.","title":"Status"},"source_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only events from this source id.","title":"Source Id"},"destination_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only events sent to this destination id.","title":"Destination Id"},"webhook_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only events of this connection id.","title":"Webhook Id"},"created_at":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only events created at this ISO 8601 time or date, for example 2026-10-01.","title":"Created At"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return (1 to 250; the API default is 100).","title":"Limit"},"next":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from pagination.next of the previous answer, to get the following page.","title":"Next"},"dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (oldest first) or desc (newest first, the default).","title":"Dir"}},"title":"list_eventsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_event":{"post":{"operationId":"get_event","summary":"Get one Hookdeck event by id with delivery status, attempts, response status, error code and timestamps. The payload is ","description":"Get one Hookdeck event by id with delivery status, attempts, response status, error code and timestamps. The payload is not included. Use for \"What happened to Hookdeck event evt_EKbUbpGzNMIdfqnXzA\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"The event id, for example 'evt_EKbUbpGzNMIdfqnXzA'.","maxLength":60,"title":"Id","type":"string"}},"required":["id"],"title":"get_eventArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_requests":{"post":{"operationId":"list_requests","summary":"List Hookdeck requests (webhooks as received from a source) with verification result, rejection cause and how many event","description":"List Hookdeck requests (webhooks as received from a source) with verification result, rejection cause and how many events they produced. Use for \"Did Hookdeck reject any incoming webhook requests\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["accepted","rejected"],"type":"string"},{"type":"null"}],"default":null,"description":"Whether the request was accepted or rejected.","title":"Status"},"source_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only requests received by this source id.","title":"Source Id"},"verified":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for requests whose signature verified, false for those that did not.","title":"Verified"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return (1 to 250; the API default is 100).","title":"Limit"},"next":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from pagination.next of the previous answer, to get the following page.","title":"Next"},"dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (oldest first) or desc (newest first, the default).","title":"Dir"}},"title":"list_requestsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_attempts":{"post":{"operationId":"list_attempts","summary":"List delivery attempts of Hookdeck events with response status, attempt number, trigger, error code and target URL. Use ","description":"List delivery attempts of Hookdeck events with response status, attempt number, trigger, error code and target URL. Use for \"Show the delivery attempts for Hookdeck event evt_EKbUbpGzNMIdfqnXzA\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"event_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only attempts of this event id.","title":"Event Id"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return (1 to 250; the API default is 100).","title":"Limit"},"next":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from pagination.next of the previous answer, to get the following page.","title":"Next"},"dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (oldest first) or desc (newest first, the default).","title":"Dir"}},"title":"list_attemptsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_issues":{"post":{"operationId":"list_issues","summary":"List Hookdeck issues (delivery failures, transformation errors, backpressure and rejected requests) with type, status an","description":"List Hookdeck issues (delivery failures, transformation errors, backpressure and rejected requests) with type, status and timing. Use for \"Are there open delivery issues in Hookdeck\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"enum":["delivery","transformation","backpressure","request"],"type":"string"},{"type":"null"}],"default":null,"description":"Issue type.","title":"Type"},"status":{"anyOf":[{"enum":["OPENED","IGNORED","ACKNOWLEDGED","RESOLVED"],"type":"string"},{"type":"null"}],"default":null,"description":"Issue status.","title":"Status"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return (1 to 250; the API default is 100).","title":"Limit"},"next":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from pagination.next of the previous answer, to get the following page.","title":"Next"},"dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (oldest first) or desc (newest first, the default).","title":"Dir"}},"title":"list_issuesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/count_issues":{"post":{"operationId":"count_issues","summary":"Count Hookdeck issues, optionally by type or status. Use for \"How many Hookdeck issues are still open\".","description":"Count Hookdeck issues, optionally by type or status. Use for \"How many Hookdeck issues are still open\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"enum":["delivery","transformation","backpressure","request"],"type":"string"},{"type":"null"}],"default":null,"description":"Issue type.","title":"Type"},"status":{"anyOf":[{"enum":["OPENED","IGNORED","ACKNOWLEDGED","RESOLVED"],"type":"string"},{"type":"null"}],"default":null,"description":"Issue status.","title":"Status"}},"title":"count_issuesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_transformations":{"post":{"operationId":"list_transformations","summary":"List Hookdeck transformations (JavaScript that rewrites a webhook before delivery) with name and code. Use for \"What tra","description":"List Hookdeck transformations (JavaScript that rewrites a webhook before delivery) with name and code. Use for \"What transformations do I have in Hookdeck\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only transformations with exactly this name.","title":"Name"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results to return (1 to 250; the API default is 100).","title":"Limit"},"next":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from pagination.next of the previous answer, to get the following page.","title":"Next"},"dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (oldest first) or desc (newest first, the default).","title":"Dir"}},"title":"list_transformationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}