Overview

This node operation registers a webhook with the CHIP Collect API. It allows users to specify a callback URL, a title for the webhook, and select one or more events that will trigger the webhook. This is useful for automating workflows based on events such as purchase creation, payment, capture, cancellation, refunds, statement generation, and webhook tests. For example, a user can register a webhook to receive notifications whenever a purchase is created or paid, enabling real-time updates in their system.

Use Case Examples

1. Register a webhook to receive notifications on purchase.created and purchase.paid events to update an internal order management system.
2. Set up a webhook to listen for statement.generated events to automatically download financial reports.

Properties

Output

JSON

• json
  • id - ID of the registered webhook
  • title - Title of the registered webhook
  • callback - Callback URL of the webhook
  • events - List of events that trigger the webhook
  • created_at - Timestamp when the webhook was created

Dependencies

• CHIP Collect API with API key and brand ID credentials

Troubleshooting

• Ensure the Webhook URL uses HTTPS protocol; otherwise, an error 'Webhook URL must use HTTPS protocol' will be thrown.
• Webhook Title is optional but recommended; if not provided, it defaults to a title derived from the webhook URL.
• At least one valid event must be selected; if none or invalid events are selected, the node defaults to 'purchase.created' and 'purchase.paid'.
• Check that the API key and brand ID credentials are correctly set and valid to avoid authentication errors.

Links

• CHIP Collect API Webhooks Documentation - Official documentation for managing webhooks with CHIP Collect API.