CAP

At PlaySignage we provide support for the protocol so that your screens running play software can be used by 3rd party systems to send and trigger alerts on them. In short the setup is as follows:

1. Create a new playlist that you wish to be activated when the CAP triggers. 
2. In the slide you can add "CAP alert" plugin, you can design the slide and select either description or headline property that will be injected into the placeholder when the alert triggers.
3. Then you tag the screens that you want the alert to be able to trigger. When you not click "edit" for the tag, you will see the TAG ID.
4. Create a new API key in our Teams page (note down the api key)
5. The tag can now be triggred according to the API: https://api.playsignage.com/docs#tag/Tag/paths/~1v1~1tags~1%7Bid_tag%7D~1alert/post
6. Depending on user region the base-url is either https://eu-api.playsignage.com or https://us-api.playsignage.com

Testing the alert trigger is a bit more technical process as we need to imitate the request as an alert service provider would send it. We are using a program curl to make the request, it can be used on both MacOS and Linux. On Windows, a program called Postman can be used. Please note you need to replace the URL (current example uses us-api), tag_id, api_key with your individual values. Also the dates in the payload for effective, onset and expires should be updated so that when the alert is triggered, it is in the active window.

 curl -X POST "https://us-api.playsignage.com/v1/tags/<tag_id>/alert" \
     -H "Content-Type: application/xml" \
     -H "Authorization: <api_key>" \
     -d '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alert xmlns="urn:oasis:names:tc:emergency:cap:1.2">
    <identifier>ALERTUS_3716_164_20260302_203832</identifier>
    <sender>PlaySignage Test</sender>
    <sent>2026-03-07T19:00:00+00:00</sent>
    <status>Actual</status>
    <msgType>Alert</msgType>
    <source>Alertus eEAS Server</source>
    <scope>Public</scope>
    <addresses>ALL</addresses>
    <code>IPAWSv1.0</code>
    <info>
        <language>en-US</language>
        <category>Safety</category>
        <event>Local Area Emergency</event>
        <responseType>None</responseType>
        <urgency>Immediate</urgency>
        <severity>Severe</severity>
        <certainty>Observed</certainty>
        <eventCode>
            <valueName>SAME</valueName>
            <value>LAE</value>
        </eventCode>
        <effective>2026-03-07T19:00:00+00:00</effective>
        <onset>2026-03-07T20:00:00+00:00</onset>
        <expires>2026-03-07T20:00:00+00:00</expires>
        <headline>HEADLINE This is a TEST of the Alertus Emergency Notification system.  NO ACTION IS NEEDED.  In a real emergency, this message will contain important alert information.</headline>
        <description>DESRCRIPTION This is a TEST of the Alertus Emergency Notification system.  NO ACTION IS NEEDED.  In a real emergency, this message will contain important alert information.</description>
        <parameter>
            <valueName>EAS-ORG</valueName>
            <value>EAS</value>
        </parameter>
        <area>
            <areaDesc>Not specified</areaDesc>
            <geocode>
                <valueName>SAME</valueName>
                <value>000000</value>
            </geocode>
        </area>
    </info>
</alert>'

To cancel an ongoing alert:

 curl -X POST "https://us-api.playsignage.com/v1/tags/<tag_id>/alert" \
     -H "Content-Type: application/xml" \
     -H "Authorization: <api_key>" \
     -d '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alert xmlns="urn:oasis:names:tc:emergency:cap:1.2">
    <identifier>ALERTUS_3716_164_20260302_203832_CANCEL</identifier>
    <sender>PlaySignage Test</sender>
    <sent>2026-03-07T19:00:00+00:00</sent>
    <status>Actual</status>
    <msgType>Cancel</msgType>
    <source>Alertus eEAS Server</source>
    <scope>Public</scope>
    <addresses>ALL</addresses>
    <code>IPAWSv1.0</code>
    <info>
        <language>en-US</language>
        <category>Safety</category>
        <event>Local Area Emergency</event>
        <responseType>None</responseType>
        <urgency>Immediate</urgency>
        <severity>Severe</severity>
        <certainty>Observed</certainty>
        <eventCode>
            <valueName>SAME</valueName>
            <value>LAE</value>
        </eventCode>
        <effective>2026-03-07T19:00:00+00:00</effective>
        <onset>2026-03-07T20:00:00+00:00</onset>
        <expires>2026-03-07T20:00:00+00:00</expires>
        <headline>This is a TEST of the Alertus Emergency Notification system.  NO ACTION IS NEEDED.  In a real emergency, this message will contain important alert information.</headline>
        <description>This is a TEST of the Alertus Emergency Notification system.  NO ACTION IS NEEDED.  In a real emergency, this message will contain important alert information.</description>
        <parameter>
            <valueName>EAS-ORG</valueName>
            <value>EAS</value>
        </parameter>
        <area>
            <areaDesc>Not specified</areaDesc>
            <geocode>
                <valueName>SAME</valueName>
                <value>000000</value>
            </geocode>
        </area>
    </info>
</alert>'

What is CAP, and how does it work with Play Digital Signage?

CAP stands for Common Alerting Protocol. It is the international standard used by governments and emergency agencies to send official alerts. Play Digital Signage automatically receives these alerts and can display them on your screens in real time.

Which alert providers do you support?

Currently we have worked with alertus.com, we are open to integrations with other alert providers, reach out to us.