Notification/List

Use this service to list and search for email notifications.

Notifications html is returned html encoded by the API. You should decode the html before displaying.

Parameters

Parameter	Type	Required	Description
notification_id	string	optional	Provide a 'notification_id' to list a specific email notification.
notification_event	string	optional	List notifications of a specific notification event.

GET https://api.recurringstack.com/{format}/Notification/List

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('notification_id' => "",'notification_event' => "");
try { $response = $rstack->request('Notification/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

API Simulator

Initiate a live call to the Notification/List service using the API simulator.

notification_id

notification_event

Your API credentials are missing, click "Set Credentials" to set them.

Notification/Create

Create and customize a new email notification. Notifications can be triggered for select events on the RecurringStack™ platform. You can choose to send a customized notification to yourself (the brand) and/or the customer.

Until and unless a notification is setup you or your customers will not receive any emails from the RecurringStack™ platform during the normal course of business.

Each notification type has a default template, you can retreive these templates by using the 'Notification/List' service. You can customize the template html to your liking while using the template placeholders.

Most event types are named after the API event they represent. You'll find a complete list of 'notification_event' types below.

Account/Create

User/PasswdReset

User/2FARequest

Subscription/Create

Subscription/Suspend

Subscription/Delete

Invoice/Create

Payment/Create

Invoice/Reminder

Parameters

Parameter	Type	Required	Description
notification_event	string	required	The type of event you wish to setup notifications for.
default_notify_brand	string	required	Provide a 'Y' to send the 'html_brand' to the 'default_notify_brand_email' when this notification is triggered; otherwise provide a 'N'.
default_notify_brand_email	string	optional	'html_brand" will be sent to this email if 'default_notify_brand' is set to 'Y'. Required if 'default_notify_brand' is set to 'Y'.
default_notify_customer	string	required	Provide a 'Y' to send the 'html_customer' to the email address on the customer Account when the 'notification_event' is triggered; otherwise provide an 'N'.
subject_brand	string	optional	The subject of the notification email when sent to the 'default_notify_brand_email'.
subject_customer	string	optional	The subject of the notification email when sent to the customer.
html_brand	string	optional	The customized html for the notification email you wish to send to the 'default_notify_brand_email'.
html_customer	string	optional	The customized html for the notification email you wish to send to the email address on the customer Account.
from_email	string	required	The email address the notification email should be sent from.

POST https://api.recurringstack.com/{format}/Notification/Create

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('notification_event' => "",'default_notify_brand' => "",'default_notify_brand_email' => "",'default_notify_customer' => "",'subject_brand' => "",'subject_customer' => "",'html_brand' => "",'html_customer' => "",'from_email' => "");
try { $response = $rstack->request('Notification/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<recurringstack transaction_id="478543">
   <notification notification_event="Account/Create" notification_id="ff71b018-e3f8-49cb-b58a-81c5c9d4c80e"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "478543"
    },
    "notification": {
        "@attributes": {
            "notification_event": "Account\/Create",
            "notification_id": "ff71b018-e3f8-49cb-b58a-81c5c9d4c80e"
        }
    }
}

API Simulator

Initiate a live call to the Notification/Create service using the API simulator.

notification_event

default_notify_brand

default_notify_brand_email

default_notify_customer

subject_brand

subject_customer

html_brand

html_customer

from_email

Your API credentials are missing, click "Set Credentials" to set them.

Notification/Update

Update an existing email notification template.

Parameters

Parameter	Type	Required	Description
notification_id	string	required	The 'notification_id' of the notification you wish to update.
default_notify_brand	string	required	Provide a 'Y' to send the 'html_brand' to the 'default_notify_brand_email' when this notification is triggered; otherwise provide a 'N'.
default_notify_brand_email	string	optional	'html_brand" will be sent to this email if 'default_notify_brand' is set to 'Y'. Required if 'default_notify_brand' is set to 'Y'.
default_notify_customer	string	required	Provide a 'Y' to send the 'html_customer' to the email address on the customer Account when the 'notification_event' is triggered; otherwise provide an 'N'.
subject_brand	string	optional	The subject of the notification email when sent to the 'default_notify_brand_email'.
subject_customer	string	optional	The subject of the notification email when sent to the customer.
html_brand	string	optional	The customized html for the notification email you wish to send to the 'default_notify_brand_email'.
html_customer	string	optional	The customized html for the notification email you wish to send to the email address on the customer Account.
from_email	string	required	The email address the notification email should be sent from.

PATCH https://api.recurringstack.com/{format}/Notification/Update

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('notification_id' => "",'default_notify_brand' => "",'default_notify_brand_email' => "",'default_notify_customer' => "",'subject_brand' => "",'subject_customer' => "",'html_brand' => "",'html_customer' => "",'from_email' => "");
try { $response = $rstack->request('Notification/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<recurringstack transaction_id="478766">
   <notification notification_event="User/Create" notification_id="aa5ceb33-5e04-4ecb-8bac-2662f8bcca83"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "478766"
    },
    "notification": {
        "@attributes": {
            "notification_event": "User\/Create",
            "notification_id": "aa5ceb33-5e04-4ecb-8bac-2662f8bcca83"
        }
    }
}

API Simulator

Initiate a live call to the Notification/Update service using the API simulator.

notification_id

default_notify_brand

default_notify_brand_email

default_notify_customer

subject_brand

subject_customer

html_brand

html_customer

from_email

Your API credentials are missing, click "Set Credentials" to set them.

Notification/Delete

Delete an existing email notification.

Parameters

Parameter	Type	Required	Description
notification_id	string	required	The 'notification_id' of the notification you wish to delete.

DELETE https://api.recurringstack.com/{format}/Notification/Delete

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('notification_id' => "");
try { $response = $rstack->request('Notification/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<notification notification_event="Subscription/Create" notification_id="1361399b-de13-4b0b-9838-97693e99db27" creation_date="2022-05-17 18:04:51" deletion_date="2022-05-22 16:48:28" status="3"/>

{
    "@attributes": {
        "notification_event": "Subscription\/Create",
        "notification_id": "1361399b-de13-4b0b-9838-97693e99db27",
        "creation_date": "2022-05-17 18:04:51",
        "deletion_date": "2022-05-22 16:48:28",
        "status": "3"
    }
}

API Simulator

Initiate a live call to the Notification/Delete service using the API simulator.

notification_id

Your API credentials are missing, click "Set Credentials" to set them.

Notification/Restore

Restore a previously deleted notification.

This service will be unable to restore a notification if one of the same type already exists.

Parameters

Parameter	Type	Required	Description
notification_id	string	required	The 'notification_id' of the notification you wish to restore.

POST https://api.recurringstack.com/{format}/Notification/Restore

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('notification_id' => "");
try { $response = $rstack->request('Notification/Restore','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<notification notification_event="User/Create" notification_id="aa5ceb33-5e04-4ecb-8bac-2662f8bcca83" creation_date="2022-05-13 12:33:55" status="1"/>

{
    "@attributes": {
        "notification_event": "User\/Create",
        "notification_id": "aa5ceb33-5e04-4ecb-8bac-2662f8bcca83",
        "creation_date": "2022-05-13 12:33:55",
        "status": "1"
    }
}

API Simulator

Initiate a live call to the Notification/Restore service using the API simulator.

notification_id

Your API credentials are missing, click "Set Credentials" to set them.

Your content here

Lorem ipsum dolor sit amet consectetur adipisicing elit. Qui, natus temporibus voluptate corporis possimus ab aut cumque.

Homepage

Quick Tips

You may remove all ID or Class names which contain _dm-, they are only used for demonstration.

Boxed Layout

Fluid Layout	Remove the `.boxed-layout` and `.centered-layout` classes from the `body`.
Centered Layout	Add a class `.centered-layout` to the `body`.
Boxed Layout	Add a class `.boxed-layout` to the `body`.
Boxed Layout with background image	Add background image to the `body`. <body class="boxed-layout" style='background-image: url("path_to_img/image.jpg");'> .. .. </body> Or it could be in your own class. .bg-img { background-image: url("path_to_img/image.jpg"); } <body class="boxed-layout bg-img"> .. .. </body>

Color Schemes

Replace the current Bootstrap CSS and Nifty CSS path with the new path of the CSS color schemes you wish to use.

This is where you can change the color scheme of your app / website.

<head>
    ...
    <title>My Project</title>
    ...

    <!-- STYLESHEETS -->
    <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--- -->

    <!-- Bootstrap CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/bootstrap.min.css">

    <!-- Nifty CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/nifty.min.css">

</head>

Header

Sticky header	Add a class `.hd--sticky` to the `#root`.
Expanded header	Add a class `.hd--expanded` to the `#root`.
Expanded header with overlapping content.	Add a class `.overlapping` to the `#content > .content__header`.
Disable rounded header.	Add a class `.rounded-0` to the `#content > .content__header`.

Navigation

Max navigation by default	Add a class `.mn--max` to the `#root`.
Min navigation by default	Add a class `.mn--min` to the `#root`.
OffCanvas navigation with PUSH mode by default	Add a class `.mn--push` to the `#root`.
OffCanvas navigation with SLIDE mode by default	Add a class `.mn--slide` to the `#root`.
OffCanvas navigation with REVEAL mode by default	Add a class `.mn--slide` to the `#root`.
Sticky navigation	Add a class `.mn--sticky` to the `#root`.
Create a ToggleButton for navigation	Add a class `.nav-toggler` to the button. Example :

Sidebar

Disable sidebar backdrop	Add a class `.sb--bd-0` to the `#root`.
Static position	Add a class `.sb--static` to the `#root`.
Stuck sidebar as the default mode	Add a class `.sb--stuck` to the `#root`.
Unite sidebar as the default mode	Add a class `.sb--unite` to the `#root`.
Pinned sidebar as the default mode	Add a class `.sb--pinned` to the `#root`.
Toggle visibility	Toggle the class `.sb--show` in the `#root`.
Create a ToggleButton for Sidebar	Add a class `.sidebar-toggler` to the button. Example :

Animations

Add the following class to the body to change the animation transition.

Transition function name	Class name
In Quart	`.in-quart`
Out Quart	`.out-quart`
In Back	`.in-back`
Out Back	`.out-back`
In Out Back	`.in-out-back`
easeInOutBack	`.easeInOutBack`
steps	`.steps`
jumping	`.jumping`
rubber	`.rubber`