get_started
Get a Trickl setup plan
Start here. Without an integration, explains the ways to add Trickl (own business such as a SaaS, or a multi-seller platform) and how to choose. With one, returns a step-by-step plan for the coding agent: keys, exact API calls, webhook handling, what to store, and how to prove it works with this server's sandbox tools.
輸入參數integration
search_docs
Search the Trickl docs
Keyword search over the Trickl partner docs (platform API, webhooks, embed widget). Returns section ids with snippets; read one with read_doc. Leave query empty for the full table of contents.
輸入參數query
read_doc
Read a docs section
Returns one section of the Trickl docs in full (Markdown), by id from search_docs.
輸入參數id必填
check_api_key
Check the API key
Confirms this connector's test key works and shows its platform, scopes and mode. Run it before the other sandbox tools; if it fails, the message says what the user needs to fix.
無需輸入參數。
register_test_provider
Register a sandbox seller
Registers a seller (provider) under the test key via POST /providers/register and returns providerLinkCode (needed to create goals) and webhookSecret (to verify webhooks). Idempotent on externalCreatorId. webhookUrl must be a public https URL that reaches the user's receiver, e.g. an ngrok or cloudflared tunnel to localhost. Sandbox webhooks are real signed HTTP requests.
輸入參數emailwebhookUrl必填websiteUrlbusinessNameexternalCreatorIdstripeConnectAccountId
create_test_goal
Create a sandbox goal
Creates a goal with POST /goals/create using the test key. No money moves. Returns goalId, paymentUrl (hosted checkout) and clientSecret (embedded checkout). Amounts are integer cents, USD.
輸入參數deadlineimageUrlmetadatacancelUrlfrequencycallbackUrldescription必填targetAmount必填depositAmountproviderLinkCode必填depositRefundable
get_goal
Get a sandbox goal
Returns a sandbox goal's current state via GET /goals/:goalId: status, amounts saved, buyer, deadline.
輸入參數goalId必填
simulate_goal_event
Simulate a goal event
Moves a sandbox goal through its lifecycle instantly; each event sends the real signed webhook to the seller's webhookUrl, exactly as live would. confirm: the buyer signs up and links a bank (goal.deposit_paid if there is a deposit; for subscriptions also goal.subscription_created, plus goal.cycle_paid at once if the deposit paid the first period in full). collect: one round-up chunk, $3 by default (goal.round_up_collected); fails with ALREADY_FUNDED when the current period is already paid. complete: one-time goals finish (goal.completed); subscriptions pay the current period and start the next (goal.cycle_paid; the goal stays SAVING). payment_failed: a failed chunk (goal.payment_failed), with reversal=true for the clawback path. expire: a deadline goal fell short (goal.deadline_charge_failed). Confirm first.
輸入參數event必填amountgoalId必填reasonreversal
cancel_test_goal
Cancel a sandbox goal
Cancels a sandbox goal via POST /goals/:goalId/cancel, as the user's server would when a customer cancels: collected chunks (and a refundable deposit) are refunded in the ledger only, and goal.cancelled is sent.
輸入參數goalId必填
list_webhook_deliveries
List webhook deliveries
Shows every webhook Trickl sent for a sandbox goal, newest first, with its payload and the receiver's result. DELIVERED = got a 2xx. FAILED = rejected, retry scheduled at nextRetryAt. EXHAUSTED = gave up. PENDING / DELIVERING = in flight; check again in a few seconds. Use lastStatusCode and lastError to debug the receiver.
輸入參數goalId必填