Note:
The field will be disregarded if it is marked as optional and the format provided is incorrect. However, a validation error will be displayed if the field is marked as mandatory and the format provided is incorrect.
"+" - means required (for all flows)
"-" - means not required (for any flow)
For instance, in POST Create Charge flow:
+6 means that the field is required for flow number 6
-6 means that the field is not required for flow number 6
Notifications
Notifications are automated messages that are triggered in response to events within the system.
Within PowerBoard, notification triggers are set up to fire on different events. Notification triggers can have different types (i.e. Webhook, Email, Sms) and events (i.e. Transaction Success).
Notifications for email and SMS require templates for the notification.
Notification resource
| field | required | type | description |
|---|---|---|---|
| type | + | string | Type of notification: webhook, email, sms |
| destination | + | string | Where to send notification (secure https:// URL for webhook, email address for email ({{EMAIL}} of the current customer), phone number in international E.164 format ({{PHONE}} of the current customer)) |
| template_id | + email, + sms | string | Custom template, which can be used with email or SMS notifications |
| event | + | string | Event to trigger a notification. |
| transaction_only | - webhook | bool | If true, the payload of an event will include information on the latest transaction only and a charge ID. The rest of the fields will be omitted. By default, it is set to false. |
| notification_service_id | - webhook | string | Authentication service ID (secure https:// links only) |
Event
| name | description |
|---|---|
| transaction_success | Transaction processed successfully |
| transaction_failure | Transaction processed unsuccessfully |
| subscription_transaction | Transaction processed by subscription |
| subscription_transaction_failure | Transaction processed by subscription unsuccessfully |
| subscription_creation_success | Subscription created successfully |
| subscription_creation_failure | Subscription created unsuccessfully |
| subscription_updated | Subscription was updated |
| subscription_finished | Subscription was finished |
| subscription_failed | Subscription failed |
| refund_requested | Refund was requested |
| refund_successful | Refund processed successfully |
| refund_failure | Refund processed unsuccessfully |
| card_expiration_warning | Card will be expired soon |
Webhook event example
PowerBoard supports the following webhook events:
- Transaction Success
- Transaction by Subscription Success
- Transaction by Subscription Failed
- Subscription Creation Success
- Subscription Finished
- Subscription Updated
- Subscription Failed
- Refund Requested
- Refund Success
- Refund Failure
- Card Expiration Warning