{"openapi":"3.1.0","info":{"title":"Checkout.com Workflows (BYOK) API","version":"0.1.0","description":"Checkout.com Workflows (BYOK) lets an AI assistant read your own Checkout.com Workflows data through the Checkout.com Workflows API with a key you supply (Checkout.com secret API key (sk_...)). Read-only: 6 tools (list_workflows, get_workflow, list_event_types, get_event, list_subject_events, get_action_invocations). The BYOK key travels with each request, is used for that one call only and is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-checkoutcom-workflows.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-checkoutcom-workflows/docs"},"termsOfService":"https://connectorbay.com/byok-checkoutcom-workflows/terms"},"servers":[{"url":"https://byok-checkoutcom-workflows.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-checkoutcom-workflows/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_workflows":{"post":{"operationId":"list_workflows","summary":"List your webhook workflows with id, name and whether each is active. Actions and signing keys are not returned. Use for","description":"List your webhook workflows with id, name and whether each is active. Actions and signing keys are not returned. Use for \"Which Checkout.com webhook workflows are active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"prefix":{"description":"Your unique Checkout.com API prefix: the first 8 characters of your client ID (vkuhvk4v for cli_vkuhvk4vjn2edkps7dfsq6emqm). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Prefix","type":"string"}},"required":["prefix"],"title":"list_workflowsArguments","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_workflow":{"post":{"operationId":"get_workflow","summary":"Get one workflow by id: name and active flag. Its webhook actions and signing key are not returned. Use for \"Is workflow","description":"Get one workflow by id: name and active flag. Its webhook actions and signing key are not returned. Use for \"Is workflow wf_6c7nnr5yfq7ube7glwhxgqwvle active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"prefix":{"description":"Your unique Checkout.com API prefix: the first 8 characters of your client ID (vkuhvk4v for cli_vkuhvk4vjn2edkps7dfsq6emqm). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Prefix","type":"string"},"workflow_id":{"description":"Workflow id, for example wf_6c7nnr5yfq7ube7glwhxgqwvle.","maxLength":200,"title":"Workflow Id","type":"string"}},"required":["prefix","workflow_id"],"title":"get_workflowArguments","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_event_types":{"post":{"operationId":"list_event_types","summary":"List the event types workflows can react to, grouped by product, with display name, description and event ids. Use for \"","description":"List the event types workflows can react to, grouped by product, with display name, description and event ids. Use for \"Which event types can a Checkout.com workflow subscribe to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"prefix":{"description":"Your unique Checkout.com API prefix: the first 8 characters of your client ID (vkuhvk4v for cli_vkuhvk4vjn2edkps7dfsq6emqm). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Prefix","type":"string"}},"required":["prefix"],"title":"list_event_typesArguments","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 past workflow event by id: type, source, timestamp, version and how its workflow actions ran. The event payload ","description":"Get one past workflow event by id: type, source, timestamp, version and how its workflow actions ran. The event payload is not returned. Use for \"What happened to event evt_az5sblvku4ge3dwpztvyizgcau\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"prefix":{"description":"Your unique Checkout.com API prefix: the first 8 characters of your client ID (vkuhvk4v for cli_vkuhvk4vjn2edkps7dfsq6emqm). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Prefix","type":"string"},"event_id":{"description":"Event id, for example evt_az5sblvku4ge3dwpztvyizgcau.","maxLength":200,"title":"Event Id","type":"string"}},"required":["prefix","event_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_subject_events":{"post":{"operationId":"list_subject_events","summary":"List the workflow events recorded for one subject, such as a payment id, with event id, type and time. Use for \"Which we","description":"List the workflow events recorded for one subject, such as a payment id, with event id, type and time. Use for \"Which webhook events fired for payment pay_mbabizu24mvu3mela5njyhpit4\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"prefix":{"description":"Your unique Checkout.com API prefix: the first 8 characters of your client ID (vkuhvk4v for cli_vkuhvk4vjn2edkps7dfsq6emqm). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Prefix","type":"string"},"subject_id":{"description":"Id of the subject the events relate to, for example a payment id such as pay_mbabizu24mvu3mela5njyhpit4.","maxLength":200,"title":"Subject Id","type":"string"}},"required":["prefix","subject_id"],"title":"list_subject_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_action_invocations":{"post":{"operationId":"get_action_invocations","summary":"Get how one workflow action ran for one event: action type, status and the delivery attempts. Use for \"Was the webhook f","description":"Get how one workflow action ran for one event: action type, status and the delivery attempts. Use for \"Was the webhook for event evt_az5sblvku4ge3dwpztvyizgcau delivered\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"prefix":{"description":"Your unique Checkout.com API prefix: the first 8 characters of your client ID (vkuhvk4v for cli_vkuhvk4vjn2edkps7dfsq6emqm). Letters, digits and hyphens only.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Prefix","type":"string"},"event_id":{"description":"Event id, for example evt_az5sblvku4ge3dwpztvyizgcau.","maxLength":200,"title":"Event Id","type":"string"},"workflow_action_id":{"description":"Workflow action id, for example wfa_uzkxbsqbhz5ebfdhy3fcvzjmwi.","maxLength":200,"title":"Workflow Action Id","type":"string"}},"required":["prefix","event_id","workflow_action_id"],"title":"get_action_invocationsArguments","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}}}}