BCL icon

BCL

Consume BCL Payment API
Join our community

Actions20

Overview

This node integrates with the BCL Payment API to manage forms, payment links, and coupons. Specifically, for the Form resource and the Update Webhook Settings operation, it allows users to update webhook notification settings for a given form. This includes enabling or disabling webhook notifications, setting the webhook URL, and selecting which events trigger the webhook.

Typical use cases include automating workflows that respond to form submissions or payment events by sending real-time notifications to external systems via webhooks. For example, when a form is submitted or a payment succeeds, the configured webhook can notify a CRM system or trigger further processing in other applications.

Properties

Name Meaning
Form ID The unique numeric identifier of the form whose webhook settings are to be updated.
Webhook Settings A collection of webhook configuration options:
- Enabled Boolean flag to enable or disable webhook notifications.
- Webhook URL The URL endpoint where webhook notifications will be sent.
- Events List of events that trigger webhook notifications. Possible values:
- Form Submit (triggered on form submission)
- Payment Success (triggered on successful payment)
- Direct Debit (triggered on direct debit event)

Output

The node outputs an array of JSON objects representing the response from the BCL API after updating the webhook settings. Each output item corresponds to one input item processed.

The json output field contains the API response data, typically confirming the updated webhook settings or providing details about the form.

If an error occurs and "Continue On Fail" is enabled, the output will include an object with error details such as:

  • error: Error message string
  • statusCode: HTTP status code returned by the API
  • timestamp: ISO timestamp of the error occurrence
  • resource: The resource involved ("form")
  • operation: The operation attempted ("updateWebhook")

No binary data output is produced by this operation.

Dependencies

  • Requires an API token credential for authenticating with the BCL Payment API.
  • The node makes HTTP requests to the BCL API base URL: https://bcl.my/api.
  • Proper network connectivity to the BCL API endpoint is necessary.
  • The user must have appropriate permissions to update form webhook settings via the API.

Troubleshooting

Common Issues

  • Authentication failures: Occur if the API token is invalid or expired.
  • Validation errors: May happen if required fields are missing or contain invalid values.
  • Permission errors: If the API token lacks rights to modify the specified form.
  • Not found errors: When the specified form ID does not exist.
  • Server errors: Temporary issues on the BCL API side.

Error Messages and Resolutions

  • Authentication failed:
    Message: "Authentication failed: Invalid or expired API token."
    Resolution: Verify and update the API token credential used by the node.

  • Validation error:
    Message: "Validation error: The API could not process your request."
    Resolution: Check that all required properties are correctly set and valid.

  • Bad request:
    Message: "Bad request: The request was improperly formatted or contained invalid parameters."
    Resolution: Review the webhook settings inputs for correctness.

  • Forbidden:
    Message: "Forbidden: You do not have permission to access this resource."
    Resolution: Ensure the API token has sufficient permissions.

  • Not found:
    Message: "Not found: The requested resource does not exist."
    Resolution: Confirm the form ID is correct and exists.

  • Server error:
    Message: "Server error: The BCL server encountered an error."
    Resolution: Retry later or contact BCL support if persistent.

Links and References

Discussion