CLI Reference

gc trigger

Trigger an event

Synopsis

Trigger a specific event. Events triggered with this command will create all other necessary 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 
  gc trigger mandate_activated 
  # trigger a mandate activated event with a customer id - this triggers a mandate activated event for the specified customer
  gc 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
  gc trigger payment_confirmed mandate=MA00192829
Copy

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
Copy

Options inherited from parent commands

      --config string   config file (default is $HOME/.gc-cli/config.json)
Copy

SEE ALSO

• gc - A CLI to help you integrate GoCardless with your application
• gc trigger billing_request_fulfilled - Trigger a billing request fulfilled event
• gc trigger billing_request_fulfilled_payment_failed - Trigger a billing request fulfilled payment failed event
• gc trigger billing_request_fulfilled_payment_paid_out - Trigger a billing request fulfilled payment paid out event
• gc trigger billing_request_pending - Trigger a billing request pending event
• gc trigger mandate_activated - Trigger a mandate activated event
• gc trigger mandate_expired - Trigger a mandate expired event
• gc trigger mandate_failed - Trigger a mandate failed event
• gc trigger mandate_pending_submission - Trigger a mandate pending submission event
• gc trigger mandate_transferred - Trigger a mandate transferred event
• gc trigger payment_chargeback_settled - Trigger a payment chargeback settled event
• gc trigger payment_charged_back - Trigger a payment charged back event
• gc trigger payment_confirmed - Trigger a payment confirmed event
• gc trigger payment_failed - Trigger a payment failed event
• gc trigger payment_paid_out - Trigger a payment paid out event
• gc trigger payment_pending_submission - Trigger a payment pending submission event
• gc trigger payment_submitted - Trigger a payment submitted event