Notifications - Emails

This document will guide you on how to correctly integrate Email Notifications within PowerBoard.

📘

Before you begin

When sending requests to PowerBoard’s API, you must provide either a Public Key and/or Secret Key depending on your use case.

API keys are generated via PowerBoard’s Merchant Dashboard, in three easy steps:

1. Login to the PowerBoard Merchant Dashboard.
2. Click on the ‘My Company’ link and proceed to the ‘API and Security’ heading.
3. On screen, you’ll see both Public and Secret Key required to send requests to PowerBoard’s API.

Your integration will utilise the following components:

• PowerBoard REST API

Overview

Use PowerBoards Notification service to get real-time updates on transaction events within your integration.

Types of events

Below is a list of events that PowerBoard currently send.

Integration Steps

Steps to integrate notifications via Email

Step 1) Identify the required events for your integration.

You can find a list of them above.

Step 2) Create an Email notification template via the PowerBoard API.

Email notifications require a pre-defined template that will outline what will be included in the body of the notification. This can be developed using HTML and via our variables captured from the respective transaction.

We have a number of variables available that can be included in the template:

API Request details:

{
    "label": "Email template",
    "notification_event": "transaction_success",
    "body": "Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created successfully.",
    "type": "message"
}

{
    "status": 201,
    "error": null,
    "resource": {
        "type": "notification-templates",
        "data": {
            "_id": "64cb07f2f3b49c1c150f917e",
            "created_at": "2023-08-03T01:50:42.310Z",
            "updated_at": "2023-08-03T01:50:42.310Z",
            "scope_id": "649a6edfb848941bea648bd6",
            "scope": "company",
            "archived": false,
            "html": false,
            "body": "Charge {{CHARGE_ID}} with {{AMOUNT}} {{CURRENCY}} created.",
            "label": "Email third template",
            "notification_event": "transaction_success",
            "type": "message"
        }
    }
}

Step 3) Register your email notification

Register your email notification by making a request to our notification's endpoint, allowing the passed email to be notified of the required events.

{
    "event": "transaction_success",
    "destination": "{{EMAIL}}",
    "type": "email",
    "transaction_only": false
    "template_id": "CREATED_TEMPLATE_ID",
    "subject": "Your email notification subject"
}

{
    "status": 201,
    "error": null,
    "resource": {
        "type": "notification",
        "data": {
            "transaction_only": true,
            "_id": "64cb087edd42c226f9b6e0dc",
            "template_id": "64cb07f2f3b49c1c150f917e",
            "type": "email",
            "event": "transaction_success",
            "destination": "{{EMAIL}}",
            "created_at": "2023-08-03T01:53:02.978Z",
            "updated_at": "2023-08-03T01:53:02.978Z"
        }
    }
}

Step 4) Test your email notification

Test your email notification ensuring that it is receiving the correct response based on the subscribed event types. You can find steps to test your setup below.

Step 5) Deploy the notification setup into our production environment.

You will need to setup the notification in our production environment, if previously configured in pre-production.

Test your integration

Before going live with your email notifications it is important to ensure it is working correctly and as expected. Follow the below steps to test and verify.

Step 1) Ensure the Notification setup steps are completed to correctly setup your PowerBoard email notification.

Step 2) Complete a transaction or event that will trigger the event you are Subscribed to.

Step 3) Verify your email notification is receiving the correct response with the correct template.

Notification logs

You can view a list of all notification logs sent by PowerBoard via API, if required. These can be filtered by date, type, event, etc.

See below example:

Unsubscribe to a notification

You can unsubscribe to a notification via our API or via the PowerBoard merchant dashboard.

Unsubscribe via API

Step 1) Identify the notification Events and ID’s you would like to unsubscribe to.

Step 2) Make a request to our DELETE notifications endpoint using the notification ID as a Path parameter.

See below example:

Step 3) Verify the event notification is longer being received by the registered destination.

Unsubscribe via the PowerBoard merchant dashboard

Step 1) Login to the PowerBoard merchant dashboard using your merchant user credentials.

Step 2) Using the left-hand side menu, navigate to the Notifications section.

Step 3) Identify the notification you would like to unsubscribe to. You can search through Notification or Event type via the Filters on the top of the page.

Step 4) On the notification you would like to delete. You will find an “Actions” button on the right-hand side of the page. Click this and select “Remove” from the dropdown.

Step 5) Verify the event is no longer triggering a notification to the registered email destination.