Developer Resources
Scenario simulators Test Bank Details Testing Webhooks (Dashboard) Viewing events in the dashboard Client Libraries Postman Collection Custom Payment Page Tools Bank ID Scenario simulators MCP New
GoCardless CLI
Installation Testing Webhooks (CLI) About CLI gocardless gocardless analytics gocardless analytics disable gocardless analytics enable gocardless analytics status gocardless cancel gocardless completion gocardless config gocardless config current-session gocardless create gocardless delete gocardless get gocardless get creditor gocardless get customer gocardless get customer_bank_account gocardless get customer_notification gocardless get event gocardless get mandate gocardless get mandate_import gocardless get payer_authorisation gocardless get payment gocardless get payout gocardless get refund gocardless get subscription gocardless get webhook gocardless list gocardless list creditors gocardless list customer_bank_accounts gocardless list customer_notifications gocardless list customers gocardless list events gocardless list mandate_imports gocardless list mandates gocardless list payer_authorisations gocardless list payments gocardless list payouts gocardless list refunds gocardless list subscriptions gocardless list webhooks gocardless listen gocardless login gocardless mcp gocardless mcp add gocardless mcp add claude gocardless mcp add codex gocardless mcp remove gocardless mcp remove claude gocardless mcp remove codex gocardless mcp run gocardless open gocardless trigger gocardless trigger billing_request_fulfilled gocardless trigger billing_request_fulfilled_payment_failed gocardless trigger billing_request_fulfilled_payment_paid_out gocardless trigger billing_request_pending gocardless trigger mandate_activated gocardless trigger mandate_expired gocardless trigger mandate_failed gocardless trigger mandate_pending_submission gocardless trigger mandate_transferred gocardless trigger payment_chargeback_settled gocardless trigger payment_charged_back gocardless trigger payment_confirmed gocardless trigger payment_failed gocardless trigger payment_paid_out gocardless trigger payment_pending_submission gocardless trigger payment_submitted gocardless update gocardless versionCLI Reference
gocardless trigger
Trigger an event
Synopsis
Trigger a specific event. Events triggered with this command will create all othernecessary webhooks and objects required to successfully create the triggered event. You can provide a resource id along with this event if you choose to limit how many objects are autogenerated. This way the provided resource can be used in the trigger process without a new one having to be created
Examples
# trigger a mandate_activated event without params - this autogenerates all objects required for mandate activation gocardless trigger mandate_activated # trigger a mandate activated event with a customer id - this triggers a mandate activated event for the specified customer gocardless trigger mandate_activated customer=customer_id # trigger a payment_confirmed event with a mandate id - this triggers a payment confirmed event for the specified mandate gocardless trigger payment_confirmed mandate=MA00192829
Options
--billing_request string A billing request resource --customer string A customer resource -h, --help help for trigger --mandate string A mandate resource --payment string A payment resource
Options inherited from parent commands
--config string config file (default is $HOME/.gc-cli/config.json)
SEE ALSO
- gocardless - A CLI to help you integrate GoCardless with your application
- gocardless trigger billing_request_fulfilled - Trigger a billing request fulfilled event
- gocardless trigger billing_request_fulfilled_payment_failed - Trigger a billing request fulfilled payment failed event
- gocardless trigger billing_request_fulfilled_payment_paid_out - Trigger a billing request fulfilled payment paid out event
- gocardless trigger billing_request_pending - Trigger a billing request pending event
- gocardless trigger mandate_activated - Trigger a mandate activated event
- gocardless trigger mandate_expired - Trigger a mandate expired event
- gocardless trigger mandate_failed - Trigger a mandate failed event
- gocardless trigger mandate_pending_submission - Trigger a mandate pending submission event
- gocardless trigger mandate_transferred - Trigger a mandate transferred event
- gocardless trigger payment_chargeback_settled - Trigger a payment chargeback settled event
- gocardless trigger payment_charged_back - Trigger a payment charged back event
- gocardless trigger payment_confirmed - Trigger a payment confirmed event
- gocardless trigger payment_failed - Trigger a payment failed event
- gocardless trigger payment_paid_out - Trigger a payment paid out event
- gocardless trigger payment_pending_submission - Trigger a payment pending submission event
- gocardless trigger payment_submitted - Trigger a payment submitted event