Bizappay

Overview

The Bizappay node's Webhook - Process Payload operation is designed to handle and parse webhook payloads received from Bizappay, a payment processing service. This operation takes the raw JSON payload sent by Bizappay when events such as bill payments or status updates occur, parses it, and outputs structured data for further workflow automation.

This node is beneficial in scenarios where you want to automate actions based on payment events, such as updating databases, sending notifications, or triggering other workflows when a bill is paid or its status changes. For example, after receiving a webhook indicating a bill has been paid, you could automatically update your accounting system or notify your sales team.

Properties

Output

The output JSON object contains the following fields:

• processed (boolean): Indicates whether the payload was successfully parsed and processed.
• payload (object): The parsed JSON object representing the webhook payload.
• event_type (string): The type of event received, if provided in the payload; otherwise "unknown".
• bill_id (string|null): The bill identifier included in the payload, or null if not present.
• status (string|null): The status of the bill or payment, if available.
• timestamp (string): The timestamp of the event, either from the payload or the current time if missing.
• message (string, optional): Error or status messages if processing failed.
• error (string, optional): Error code or message if an error occurred during parsing or serialization.
• errorType (string, optional): Type of error encountered (e.g., "JSON_PARSE_ERROR" or "PAYLOAD_SERIALIZATION_ERROR").

If the payload cannot be parsed as valid JSON, the output will indicate failure with appropriate error details.

Dependencies

• Requires an active connection to Bizappay API for other operations, but this specific operation only processes incoming webhook payloads locally.
• No external API calls are made during payload processing.
• No special environment variables or credentials are needed for this operation itself, but the node requires an API key credential configured for other Bizappay interactions.

Troubleshooting

• Invalid JSON Payload: If the webhook payload is not valid JSON, the node will return a JSON_PARSE_ERROR. Ensure that the payload passed to the node is a correctly formatted JSON string.
• Non-Serializable Data: If the payload contains data that cannot be serialized back to JSON, a PAYLOAD_SERIALIZATION_ERROR will be returned. Check the payload content for unsupported types.
• Empty or Missing Payload: The property Webhook Payload is required. Omitting it or passing an empty string will cause an error.
• Unexpected Payload Structure: Since the node expects certain fields like event_type or bill_id, absence of these fields will not cause errors but may result in default values ("unknown" or null) in the output.

Links and References

• Bizappay Official Documentation (for webhook payload structure and event types)
• n8n Webhook Node Documentation (general webhook handling concepts)

This summary focuses exclusively on the Webhook - Process Payload operation of the Bizappay node as requested.