Doorbird integration

Guys can someone explain what is this new token attribute under doobird configuration, where it is needed and why is it needed?

Anything you type there doorbird is working.

You can find your token on the Digital Passport sheet that came with your doorbirdā€¦it had you admin username and password along with a scan-able QR code.

The token was added as a means for authenticating the endpoint that is used for Doorbird events. It simply prevents unauthorized users from calling the endpoint if they do not know the token that is in the configuration. The token is not related to the information on the Doorbird passport, but should be protected since it is essentially a password for the endpoint. I recommend placing it in secrets.yaml configuration file.

Since the time that this change was made, HA has implemented a webhook system. In a future release the Doorbird component will be upgraded to use webhooks which will remove the need for this token.

In the doorbird app - admin - relays - schedule, there is the possibility to assign a http API call also.
Is this of any use and can it be used to also notify if someone opens gate by separate keypad (Act5e) on same circuit? (sorry not too hot on electrical stuff)

Is this of any use

Yes, This is how the HA Doorbird component receives events for motion and doorbell events from the door station.

can it be used to also notify if someone opens gate by separate keypad (Act5e) on same circuit?

I believe that there are plans to integrate http calls for relay events in a future firmware update, but currently it is not supported by Doorbird API. We will integrate it as soon as possible after the firmware drops.

1 Like

Im trying to get this working however the standard api HTTP call http://ā€¦ wont work as im running HA in docker on a synology NAS which holds port 80 for its own admin uses.
Im also applying https to the HA instance. ive tried adding a port, 8123, to the hass_url_override url but that doesnt work either.
i cannot get this to work, any suggestions?
thx

Similar working situation, NUC with HA in docker
Docker container using network_mode: ā€œhostā€

Checked my api calls in doorbird app and they use my https HA address

For doorbird in configuration.yaml

doorbird:
  token: random_token
  devices:
    - host: door.bird.lan.ip
      username: 123
      password: xyz
      name: Gate
      monitored_conditions:
        - doorbell
        - motion

@stavroz Did you verify the URL for the HTTP call in the Doorbird app (administration settings)? That URL should include the port by default. You can copy that URL and try to manually access it in your browser. If it works as expected, you should see an OK response.

@fergalom Iā€™m going to do more testing around using custom host with a custom port. I donā€™t currently use HASS or a custom host, so Iā€™m not sure what could be happening.

@oblogic7, my instance is working perfect, was trying to help out @stavroz as his setup is similar to mine

Ahā€¦ I see. Thought you were reporting a similar problem.

OK i got it going. turns out i had 2 issues, when i changed back from using hass-override it works!
thanks.

I am unable to get my automation to trigger when the doorbell button is pressed. I had it working before and I donā€™t know when it stopped.

I can see the event under the events sections in HA ā€˜doorbird_frontdoorbird_buttonā€™ and when I click fire event, my automation triggers, but not when the button is pressed.

All my cameras show up in HA front end and are working, so I know my HA and doorbird connection is working.

My automation trigger when the doorbell button is pressed is not working too. It was working before I updated HA to current latest version.

In the Doorbird app, there are 2 HTTP calls:
1 - https://ha_local_ip:8123/api/doorbird/doorbird_button?token=myToken
2 - (legacy): https://ha_local_ip:8123/api/doorbird/doorbell

Is this correct? Can I remove legacy one? or is it managed by home assistant, and it will be deleted automatically?

@silfa718 If you look in the settings on the Doorbird app, you can verify the calls that are setup to be made when the button is pressed. You can enter the URL into your web browser and call it to test. You should see a response of OK if the call is working properly.

@sviudes You can remove the legacy URL as it is no longer needed. The HA component doesnā€™t clean up the URL automatically, but you can fire the doorbird_reset_favorites event to clear out all URLs. You would then need to restart HA to reregister the calls that are used.

1 Like

One more thing that I forgot to mention, the calls are controlled by a schedule in the Doorbird app. The calls are only made during time periods which have a blue square. You can verify the doorbell schedule in the Doorbird app settings as well.

what url do i put in the browser?

This link: http://hassip:8123/api/doorbird/frontdoor_button

When i try the about link, all that comes up is Unauthorized.

This link

And as mentioned check your door bird http call schedule.

You can find it in settings> administration (login with admin account) > schedule > than click on the left top on the bell icon to switch to http call schedule. Make sure you make it blue when you want it active during the time period you desire.

My schedule is all blue, and when I go to the link it says unauthorized

You sure you have the right token?
The token should be stored in your configuration

I was going to the wrong link, now when I do it, the page comes up with OK