Overview
The OpenPix Trigger node is designed to handle incoming webhook events from the OpenPix API within n8n workflows. It allows users to listen for specific OpenPix events (such as payment updates or notifications) and trigger automated workflows in response. This node is particularly useful for automating processes based on real-time events from OpenPix, such as updating records, sending notifications, or integrating with other systems when a payment event occurs.
Practical examples:
- Automatically update your CRM when a payment is received via OpenPix.
- Send an email notification when a specific OpenPix event occurs.
- Log all OpenPix webhook events into a database for auditing purposes.
Properties
| Display Name | Type | Description |
|---|---|---|
| Event Names or Name or ID | options | The event to listen to. Choose from the list, or specify IDs using an expression. The available options are dynamically loaded from your OpenPix account's supported events. |
Output
The node outputs the full JSON payload received from the OpenPix webhook. The structure of this output depends on the specific event sent by OpenPix, but it will always be accessible under the json field in n8n.
Example output structure:
{
"json": {
// All fields as provided by the OpenPix webhook event body
// Example:
"event": "PAYMENT_RECEIVED",
"data": {
"paymentId": "12345",
"amount": 1000,
// ...other event-specific fields
}
}
}
Note: The actual fields depend on the event type sent by OpenPix.
Dependencies
- External Service: Requires an active OpenPix account.
- API Key: You must configure valid OpenPix API credentials in n8n (credential type:
openpixApi). - n8n Configuration: No additional environment variables are required beyond standard credential setup.
Troubleshooting
Common issues:
- Webhook not triggering: Ensure that the webhook URL is correctly registered with OpenPix and that your workflow is active.
- Invalid credentials: If the API key is incorrect or missing, the node will fail to register or delete webhooks.
- Event not listed: If the desired event does not appear in the dropdown, verify your OpenPix account supports it and that the node can reach the OpenPix API.
Error messages:
"NodeApiError": Indicates a problem communicating with the OpenPix API (e.g., network error, invalid credentials, or insufficient permissions). Double-check your API key and network connectivity."webhookId undefined": If the webhook creation response does not include an ID, the node cannot track or delete the webhook. Try recreating the webhook or check OpenPix API status.