WordPress Plugin: WP Notify Plugin Documentation

Introduction


Welcome to the documentation for WP Notify for WordPress!
Here you'll be able to learn how it works and explore the features available.
If you have any questions please feel free to contact us

Requirements


To quickly get set up, you'll need to ensure that you have the below requirements.

  • WordPress 4.0+

    Woocommerce Store 3.0+ (Optional)

Installing the Plugin


Follow the below steps to install the plugin on your WordPress site:

  • Login into your WooSignal account (or create an account if you are new).

  • Once you reach the Dashboard, on the left nav bar look for "Plugins" and click the link.

  • After downloading the plugin, visit your WordPress site and login to get to your admin dashboard. On your nav bar, look for "Plugins" like the below image.

    Select "Add New" and proceed to the next step below.

  • Then select "Upload plugin" like the below image

    This will open a box below where you can upload a .zip file.

  • Click "Choose file" can look for the WooSignal plugin you downloaded and select the .zip file to install. After you select "Install Now". You should then be able to activate the plugin from your WordPress admin to start using it.

  • If you followed all the steps above you should now be ready to start using the plugin.

API Requests: WordPress


Storing token

Returns a status code of 200 if the request was successful

[POST]

Path /wp-json/wpnotify/v1/token/store

Body Parameters

{
    "token": "fcm token",
    "user_id": "12"
}

Response:

1{
    "data": [],
    "message": "Token stored successfully in WP",
    "status": 200
}

Update token status

Returns a 200 if a token was updated, use this method to set the current status of a fcm token e.g. 1 = active, 0 = inactive.

[POST]

Path /wp-json/wpnotify/v1/token/update

Body Parameters

{
    "token": "203cff6ff4",
    "status": "1"
}

Response:

1{
    "data": [],
    "message": "Token updated successfully in WP",
    "status": 200
}