CMS Integrations

We provide a WordPress plugin and a Drupal module to simplify the web integration process for those platforms. Setup instructions are provided for each.

WordPress Setup

 Important

The WordPress plugin does not currently work with projects hosted on Airship’s EU Cloud Site.

  1. Configure your site for web push notifications via the Airship dashboard, following the steps in Airship Setup, and download your ZIP file.

  2. Navigate to the Plugins tab of your WordPress admin dashboard and install our Airship Web Push Notifications plugin.

     Note

    If your WordPress site is not HTTPS, please see our documentation on Secure Integration for details on how to securely host the necessary files and registration page.

  3. Navigate to the plugin’s Settings page, upload the SDK Bundle ZIP file that you downloaded in Step 1, and enter the Master Secret for your Airship project. You can copy the Master Secret from the Settings page in your Airship project.

    You’ll know you’ve done this successfully if you get green check marks next to both items under Service Connectivity.

  4. Configure optional settings, including how you’d like to prompt your site visitors to opt in to notifications.

    • Our WordPress plugin offers a CSS Class that can be used to add a custom opt-in prompt or button to your site.

    • You can also use the Opt-In Prompt settings to customize when to show your users the default browser prompt, e.g., after 3 page views.

Now that you’ve finished setup, you’re ready to start sending notifications. You may send notifications from the Airship dashboard, or directly from your WordPress admin page. Our plugin includes the ability to automatically send a web push notification when publishing or updating any public post type (including custom post types) on your WordPress site as well as the ability to send a one-off web push notification at any time from your WordPress dashboard using our custom content type.

Drupal Setup

  1. Configure your site for web push notifications via the Airship dashboard, following the steps in Airship Setup, and download your ZIP file.

  2. Navigate to your Drupal dashboard and install our Airship Web Push Notifications module. The module supports both Drupal 7 and 8.

     Note

    If your Drupal site is not HTTPS, please see our documentation on Secure Integration for details on how to securely host the necessary files and registration page.

  3. Navigate to the module’s settings page (Configuration » Web Services » Airship Web Push Notifications), and:

    • On the Credentials tab, enter your Airship App Key and Master Secret. You can copy the App Key and Master Secret from the Settings page in your Airship project.

    • On the SDK Bundle tab, upload the SDK Bundle ZIP file that you downloaded in Step 1.

    • On the Opt-In Prompt tab, choose how you’d like to prompt your site visitors to opt-in to notifications. Either use a custom Modal, Banner, or Button to prompt your visitors, or check the “Do Not Use Custom Opt-In Prompt” box to use the default browser prompt. You may also choose where on the page to display your prompt and when to display it, e.g., after 3 page views. Note: You cannot customize the location of the default browser prompt.

  4. Enable notifications for specific content types. Navigate to Structure » Content Types, and click to select a desired Content Type, such as Article.

    For each selected content type, on the Edit tab, select Airship Web Push Notifications, then check the box for Enable Notifications. You may also set the content type’s default notification text, such as the Node Title.

Now that you’ve finished setup, you’re ready to start sending notifications. You may send notifications from the Airship dashboard, or directly from the Drupal UI. Our module includes the ability to automatically send a web push notification when publishing or updating any piece of content on your Drupal site, as well as the option to schedule a notification for a date and time in the future.