AbacatePay Trigger icon

AbacatePay Trigger

Integre em tempo real a AbacatePay para eventos de pagamentos PIX, cobranças, clientes, cupons e saques
Join our community

Overview

This node acts as a real-time trigger for AbacatePay events, enabling workflows to respond immediately when specific payment-related or customer-related events occur. It listens for webhook calls from AbacatePay and triggers the workflow when selected events happen, such as PIX payments completing, billing being paid, coupons being redeemed, or withdrawals failing.

Common scenarios include:

  • Automating order fulfillment or notification after a payment is completed.
  • Updating customer records when their information changes.
  • Reacting to coupon usage or expiration to adjust marketing campaigns.
  • Handling withdrawal statuses to reconcile accounts.

For example, you could use this node to automatically send an email receipt when a billing is paid or update your CRM when a new customer is created.

Properties

Name Meaning
Events Select one or more event types that will trigger the webhook. Options include:
- Billing Cancelled, Created, Expired, Paid
- Coupon Created, Expired, Redeemed
- Customer Created, Updated
- PIX Payment Cancelled, Completed, Expired
- PIX QR Code Created
- Withdraw Completed, Created, Failed
Authentication Method to validate incoming webhook requests:
- None (no authentication)
- Basic Auth (username and password)
- Header Auth (custom header name and value)
Username Username for basic authentication (shown only if Basic Auth is selected).
Password Password for basic authentication (shown only if Basic Auth is selected).
Header Name Name of the HTTP header used for authentication (default "Authorization", shown if Header Auth).
Header Value Value of the HTTP header used for authentication (shown if Header Auth).

Output

The node outputs JSON data representing the event payload enriched with additional metadata:

  • event: The normalized event type string (e.g., "pix.payment.completed").
  • resourceType: The resource category inferred from the event data (e.g., "billing", "customer").
  • timestamp: ISO timestamp of when the event was processed.
  • headers: The HTTP headers received in the webhook request.
  • Event-specific fields, e.g., amounts and customer details:
    • amounts: Contains raw amount, formatted currency strings, fees, and net amounts if applicable.
    • customer: Parsed customer info including name (split into parts), email address and domain, and document type with cleaned tax ID.
  • status: Boolean flags indicating payment status states like isPaid, isExpired, isCancelled, etc.

If the event does not match the selected triggers or fails authentication, the node returns no output to prevent workflow execution.

Dependencies

  • Requires receiving webhook calls from AbacatePay configured to point to this node's webhook URL.
  • Optional authentication setup via Basic Auth or custom header to secure webhook endpoint.
  • Uses internal helper functions for parsing and formatting amounts, names, emails, and document types.

No external API keys or credentials are required beyond configuring the webhook authentication method.

Troubleshooting

  • Webhook not triggering: Ensure the AbacatePay service is correctly configured to send webhooks to the node’s URL and that the selected events include the event sent.
  • Authentication failures: If using Basic Auth or Header Auth, verify the username/password or header name/value exactly match those configured in AbacatePay.
  • No workflow execution despite event: Check that the event type received matches one of the selected events; otherwise, the node ignores it.
  • Malformed data errors: The node expects certain fields in the webhook payload; if AbacatePay changes its format, the node may fail to parse data correctly.

Links and References

Discussion