BTCPay Trigger icon

BTCPay Trigger

Starts the workflow on a BTCPay event

BTCPay Trigger

AI-generated

Overview

This node triggers an n8n workflow based on events from a BTCPay Server store, specifically when a payment request is completed. It is useful for automating processes that depend on payment status updates in BTCPay Server, such as order fulfillment or notification systems. For example, when a payment request is marked as completed, this node can start a workflow to update a database or send a confirmation email.

Use Case Examples

  1. Trigger a workflow when a payment request is completed in a BTCPay Server store to automate order processing.
  2. Start a workflow to notify a user when their payment request status changes to completed.

Properties

Name Meaning
Store Name or ID Select the BTCPay Server store by name or ID where the webhook will be registered and events monitored.
Event Type of BTCPay event that triggers the workflow. Currently supports 'Payment Request Completed' only.

Output

JSON

  • webhookResponse
    • status - HTTP status code returned to BTCPay Server after webhook processing.
    • message - Message describing the webhook processing result.
  • workflowData - Data passed to the workflow, containing the event payload when a payment request is completed.

Dependencies

  • Requires a BTCPay Server API key credential with permission to view store settings and manage webhooks.

Troubleshooting

  • Common issues include missing or incorrect API key permissions, which prevent store listing or webhook creation.
  • If the webhook signature validation fails, the node throws an 'Invalid signature' error with HTTP 403 status. Ensure the webhook secret is correctly stored and the BTCPay Server sends valid signatures.
  • If an unsupported event is selected, the node throws an error indicating the event is not supported.

Links

Discussion