Trigger alarm webhook

With this action, you can fire a webhook trigger from the UniFi Protect Alarm Manager, which runs the alarms that use it.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To use this action in an automation or script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create to start a new one.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger.
4. In the Then do section, select Add action.
5. From the search box, search for and select Trigger alarm webhook.
6. Fill in the fields, then select Save.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required. For how an automation or a script is built in YAML, refer to Automations in YAML and Scripts.

In YAML, refer to this action as unifiprotect.trigger_alarm_webhook. A basic example looks like this:

action: unifiprotect.trigger_alarm_webhook
data:
  config_entry_id: 1234567890abcdef1234567890abcdef
  trigger_id: 0b6c5a2e-9d3f-4c1a-8e7b-2f4d6a8c1e3b

Options in YAML

Good to know

• Only administrators can use this action.
• Unlike the other UniFi Protect actions, this one also works in API key only mode.
• UniFi Protect doesn’t always reject an unknown trigger ID, so a typo can fail silently.

Try it yourself

Ready to test this? Open Settings > Tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup. In the visual editor, select the UI options listed in the example or paste the YAML code.

Automation: start a Protect alarm when the house is armed away

Fire an Alarm Manager trigger when the Home Assistant alarm is armed away, for example to start recording on all cameras.

• Trigger: State changed: Home alarm changes to Armed away
• Action: Trigger alarm webhook

alias: "Start Protect alarm when armed away"
triggers:
  - trigger: state
    entity_id: alarm_control_panel.home_alarm
    to: "armed_away"
actions:
  - action: unifiprotect.trigger_alarm_webhook
    data:
      config_entry_id: 1234567890abcdef1234567890abcdef
      trigger_id: 0b6c5a2e-9d3f-4c1a-8e7b-2f4d6a8c1e3b

Automation: sound a chime when a door opens at night

Fire an Alarm Manager trigger when the front door opens at night, for example to play a sound on a chime.

• Trigger: State changed: Front door changes to Open
• Condition: Time: after 22:00, before 06:00
• Action: Trigger alarm webhook

alias: "Chime when the front door opens at night"
triggers:
  - trigger: state
    entity_id: binary_sensor.front_door
    to: "on"
conditions:
  - condition: time
    after: "22:00:00"
    before: "06:00:00"
actions:
  - action: unifiprotect.trigger_alarm_webhook
    data:
      config_entry_id: 1234567890abcdef1234567890abcdef
      trigger_id: 7d1e4b9a-2c6f-4a8e-b3d5-9f0a1c2e4b6d

Still stuck?

To test the action on its own, run it in the automation editor with Run action, and check the message that it shows. To see what the action did when the automation ran, open the trace of that run. For details, refer to Testing automations. For common problems and their solutions, refer to Troubleshooting automations.

If that doesn’t help, the Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.