Webhook Service is LIVE

[iklein99]

The Webhook Service is LIVE!

Why do I need to this?

In order to get updates from your devices, the plugin polls your devices (unless disabled) fairly frequently, but no more than once every 5 seconds.

If you have a lot of devices, this produces quite a bit of traffic as each device gets polled separately. This will also result in timeouts occasionally and you may see errors in your logs.

Additionally, the updates are a little delayed. So if you are using motion detectors, for instance, the delay of 5 seconds in getting an update into Home Kit can be a problem.

This service eliminates the polling. The plugin will wait for events to come from SmartThings through the Web Hook services. This results in minimal network traffic and near real-time updates of device state.

Getting Access

In order to get access, you need to do four main things:

1. Go to https://www.kleinstudios.net/ and purchase a Webhook Access Token. The service is free for the first 7 days, then you are charged $2.99 per month. You can cancel any time.
2. Set up a Smart App on your SmartThings account (follow the How To link on the Webhook site)
3. Install the Smart App using the SmartThings mobile app (also described in the How To link on my site)
4. Add the Webhook Access Token to the plugin configuration in Homebridge

While the webhook service has been tested for several weeks now, the purchase site was just launched. So I'd appreciate any feedback.

Thanks all!

Ira

[blaine07]

Kleinstudios URL won’t work?

[blaine07]

Kleinstudios URL won’t work?

Also, in the “Getting Access” portion can you please provide links to the setup instructions for dummy heads like me?

Also, if for some reason, we are to offboard/service is no longer provided could/can things get put back to as is now before subscribing to the service?

[iklein99]

Please try again. Something wrong with the link. Setup instructions are on the site. Let me know how it goes.

You can always remove the WebHook Access token from the configuration for the plugin and it will start polling again. You can cancel the subscription from the site. Thanks for letting me know about the issue.

[blaine07]

Yes, will report back. Mobile this afternoon but this evening I’ll mess with and report back! I’m sure it’ll go well. :-)

[iklein99]

All, someone brought to my attention that Samsung moved some things around in their app, and I had to make a change to the directions. Please note that if you don't see a "Discover" tab at the top of the "Create a Routine" page, you have the latest app, and you can find the smart app config in the "Automations" screen by touching the circle icon at the top right-hand side of the screen.

[jl0810]

I don't see any way now to add / discover this app -- has something changed?

[coryabooth]

[iklein99]

Try and go through the setup screen in the SmartThings app again through to the end.

[iklein99]

Corey, I think you may have set the wrong permissions when you set up the Smart App in the developer workspace. You shouldn't see "control your devices" when you go to do the install. You should see "See your devices". Check the permissions. You can always delete the Smart App and create a new one. The access token you get from my site will work. See the image below.

[coryabooth]

Corey, I think you may have set the wrong permissions when you set up the Smart App in the developer workspace. You shouldn't see "control your devices" when you go to do the install. You should see "See your devices". Check the permissions. You can always delete the Smart App and create a new one. The access token you get from my site will work. See the image below.

[coryabooth]

Corey, I think you may have set the wrong permissions when you set up the Smart App in the developer workspace. You shouldn't see "control your devices" when you go to do the install. You should see "See your devices". Check the permissions. You can always delete the Smart App and create a new one. The access token you get from my site will work. See the image below.

I fully deleted and recreate the Developer App - still says "Control your devices" and still Error 400

[coryabooth]

[joshschools]

Awesome! This works great, no more errors on my homebridge log. Super responsive! For people having problems accessing the website. I had to put "www" before the website to get the page to load.

[coryabooth]

[iklein99]

That’s expected.  You aren’t making a valid call to the api.  Sent from my iPhoneOn Feb 25, 2023, at 7:32 PM, coryabooth ***@***.***> wrote: —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you authored the thread.Message ID: ***@***.***>

[gvchagas]

I have a doubt, for WindFree air conditioners will it be possible to do other tasks, in addition to turning it on and off, how to choose the mode (hot or cold), temperature and ventilation speed?

[iklein99]

Air conditioners are not yet supported by the plugin.

…

On Feb 25, 2023, at 9:12 PM, gvchagas ***@***.***> wrote: I have a doubt, for WindFree air conditioners will it be possible to do other tasks, in addition to turning it on and off, how to choose the mode (hot or cold), temperature and ventilation speed? — Reply to this email directly, view it on GitHub <#141 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABG55ETR5JTINF7GTJGORA3WZK3X3ANCNFSM6AAAAAAVH7RRDU>. You are receiving this because you authored the thread.

[gvchagas]

Thanks for the reply! So i'll wait for the support, because i only have a Air conditioner with Smart Things.

[coryabooth]

Apologizes for spamming this thread...

I am still stuck however...

I have used CLI to clean everything out, recreated the Webhook in the Developer section numerous time.
I have found the "Test" SmartApp each time, without any issue
I have my Webhook Token
I select "all devices"

But at the final screen, its says "Control" and does not display my selected devices.

And it responds with "Failure: 400 Bad Request"

Is there anything I can check? Some sort of logging?
Anything to do with Client ID / Secret?
The Developer sites makes heavy mention of "Developer Mode" - perhaps I need adjust a setting in the App for this?

In the Developer section under "Live Log" - all I see is:
CONTROL_EVENT{ "type": "CONTROL_EVENT", "data": "welcome", "lastEventId": "", "origin": "https://spigot-regional.api.smartthings.com" }

In the HomeBridge UI - the "Live Log" says:
[2/25/2023, 11:18:20 PM] [Smartthings Plug (IK)] Could not connect to web hook service: AxiosError: Request failed with status code 401. Will retry

This thread seems very similar:
https://community.smartthings.com/t/multiple-devices-causes-error-in-smartapp-automation/246749

EDIT

Progress! Using the thread above, there is a discussion of a potential limit on devices (perhaps 20?)
I reduced my device selection to just my locks (2) - and it worked

I was able to add 18 devices successfully - but it does seem to crash with over 20:

Perhaps this has some confirmation:
https://developer.smartthings.com/docs/advanced/rate-limits/

Guardrail | 30 | Max number of devices per Installed App (Cloud Connected)

[iklein99]

Cory do you have any blinds? Try this. When you go into the ST app to select your devices, just select a few switches and try it. Let m know if that works. It could be a problem with a device type. I don’t own all of them so something may not be working. Someone else said they had a problem adding blinds.

…

On Feb 26, 2023, at 12:08 AM, coryabooth ***@***.***> wrote: Apologizes for spamming this thread... I am still stuck however... I have used CLI to clean everything out, recreated the Webhook in the Developer section numerous time. I have found the "Test" SmartApp each time, without any issue I have my Webhook Token I select "all devices" But at the final screen, its says "Control" and does not display my selected devices. And it responds with "Failure: 400 Bad Request" Is there anything I can check? Some sort of logging? — Reply to this email directly, view it on GitHub <#141 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABG55ETOG73GDSN6J3ICWLTWZLQN3ANCNFSM6AAAAAAVH7RRDU>. You are receiving this because you authored the thread.

[iklein99]

Cory, I believe I know your issue. Hang on while I try something on my end. Something seems to have gone wrong while registering your account. The issue seems to be on my side. Let me have a look.

…

On Feb 26, 2023, at 12:08 AM, coryabooth ***@***.***> wrote: Apologizes for spamming this thread... I am still stuck however... I have used CLI to clean everything out, recreated the Webhook in the Developer section numerous time. I have found the "Test" SmartApp each time, without any issue I have my Webhook Token I select "all devices" But at the final screen, its says "Control" and does not display my selected devices. And it responds with "Failure: 400 Bad Request" Is there anything I can check? Some sort of logging? — Reply to this email directly, view it on GitHub <#141 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABG55ETOG73GDSN6J3ICWLTWZLQN3ANCNFSM6AAAAAAVH7RRDU>. You are receiving this because you authored the thread.

[iklein99]

Cory, it looks like even though you are getting an error, the the devices are installed. I see 2 installations for you. One with 33 devices and one with 2. Here what you should try:

1. configure the plugin by entering your Webhook access token into the plugin config and restart.
2. I assume the second install was just with the 2 devices. Test that out and see if you are getting the events. You can see this with Debug on, or change the state of one of those devices and confirm that the state is changing in the Home app
3. If that is the case, try going into the SmartThings app and adding the rest of your devices (maybe a little at a time). Keep testing, but you should see the events come through.
4. Let me know after you've added the Access Token and restarted your homebridge so I can see how things look on my end.

[iklein99]

Everyone, I believe there may currently be a limit of around 39 devices to be in the subscription. I'm looking into this and hope to have a fix soon.

[iklein99]

Hi all, I found a solution to the problem. For now, you have to stay around 35 or so devices until I put out a fix. I promise to get one in soon. Thanks.

[iklein99]

Ok everyone. Problem is fixed. When go into the SmartThings app, you no longer have to select devices. It will monitor all of your devices as long as they support one of the supported capabilities. Thanks for your patience.

[joshschools]

I get this in the Smartthings when I try to approve the access to the devices.

…

On Sun, Feb 26, 2023 at 3:42 PM iklein99 ***@***.***> wrote: Ok everyone. Problem is fixed. When go into the SmartThings app, you no longer have to select devices. It will monitor all of your devices as long as they support one of the supported capabilities. Thanks for your patience. — Reply to this email directly, view it on GitHub <#141 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AD7QNDEMQUO4HWZWTIL2PPDWZPE3VANCNFSM6AAAAAAVH7RRDU> . You are receiving this because you commented.Message ID: <iklein99/homebridge-smartthings/repo-discussions/141/comments/5116482@ github.com>

[iklein99]

Josh, not sure if you mean to attach or include something. All I see is "I get this...".

What are you seeing?

[joshschools]

[iklein99]

WhT time zone are you in?Sent from my iPhoneOn Feb 26, 2023, at 9:22 PM, joshschools ***@***.***> wrote: —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you authored the thread.Message ID: ***@***.***>

[iklein99]

It appears that a small number folks that have set up the webhook smart app are not receiving events from smartthings. This is because somehow the ID that gets created when you install the app isn't matching what is in the database. I'm not sure how this happened - I'm looking at it, but for now, if you are experiencing issues, perform the following:

1. Open the ST app on your mobile device
2. Go to the Automations tab
3. Scroll down to the Smart App for the webhook and open that
4. Click 'Done' at the bottom, then 'Allow' on the next screen
5. Wait about 5 minutes and see if your getting updates

Sorry about the issue.

[blaine07]

It appears that a small number folks that have set up the webhook smart app are not receiving events from smartthings. This is because somehow the ID that gets created when you install the app isn't matching what is in the database. I'm not sure how this happened - I'm looking at it, but for now, if you are experiencing issues, perform the following:

1. Open the ST app on your mobile device
2. Go to the Automations tab
3. Scroll down to the Smart App for the webhook and open that
4. Click 'Done' at the bottom, then 'Allow' on the next screen
5. Wait about 5 minutes and see if your getting updates

Sorry about the issue.

Hey, you, yes YOU— thank YOU for keeping this going and working for US. You’re doing a great job at solving issues as they come around and WE APPRECIATE IT! 😀

[swav8tor]

Just signed up and installed. So far working as advertised. Thank You.

[alaw168]

Signed up and installed over the weekend. Works great so far.

A couple of minor things.

1. I'm still getting sporadic messages in the log like this:

[30/05/2023, 09:18:52] [homebridge-smartthings-ik] This plugin slows down Homebridge. The read handler for the characteristic 'Battery Level' was slow to respond! See https://homebridge.io/w/JtMGR for more info.

Does it mean it is still polling from ST?

2. Somewhere in the log that mentions webhook is in use would be nice. Also, regular log messages on events (I can see them in debug logs) would also be nice.

[jeffp94114]

Hmmm, I got all the way through the instructions ok, but at the very end when I restart Homebridge I get, "No plugin was found for the platform "HomeBridgeSmartThings" in your config.json. Please make sure the corresponding plugin is installed correctly."

Is there maybe an alternative name I should be trying there? Thx

[iklein99]

@jeffp94114 , Can you go into the plugins screen and send a screenshot of the plugins page? Also send me your config file, remove your access tokens first.

[jeffp94114]

Ha, my bad - I did everything except remember to install the plug-in itself in Homebridge :-) Added it in and now everything's working, thanks!

[iklein99]

Can you go into the plugins screen and send a screenshot of the plugins page? Also send me your config file, remove your access tokens first.

[iklein99]

No. Sorry.

…

On Jul 26, 2023, at 4:41 PM, C. Albert Thompson ***@***.***> wrote: I have a domain name and HTTPS certificate that I can deploy the webhook. Is there someway I can set that up? — Reply to this email directly, view it on GitHub <#141 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABG55EUEBG7CO3CQTACNDYTXSF6GZANCNFSM6AAAAAAVH7RRDU>. You are receiving this because you authored the thread.

[nicofriedrich]

Hey @iklein99, don't know what I'm doing wrong here:

Did the whole setup.

• ST dev portal
• ST app
• HB config

But I can't see my devices. So no webhook is being called on an update.
Just the welcome msg in ST dev portal:

{ "type": "CONTROL_EVENT", "data": "welcome", "lastEventId": "", "origin": "https://spigot-regional.api.smartthings.com" }

Do you have any tips?

I saw that there might be a problem with too much devices but I just have 6 at the moment.

[iklein99]

@nicofriedrich , you say you don't see any devices? You mean you don't see your devices in the Home app?

[nicofriedrich]

you say you don't see any devices?

Sry, I don't see devices on ST-APP
Let me share a screen:

[iklein99]

What is the english translation of that drop down selection? It should say "see your devices". I am interested what devices you see in the Apple Home app. You don't need the webhook to see devices.

[nicofriedrich]

What is the english translation of that drop down selection? It should say "see your devices". I am interested what devices you see in the Apple Home app. You don't need the webhook to see devices.

Sry its in german, but the list of devices is empty when I try to allow specific devices. (last step from webhook app)
But they are all (6 devices) in ST-App and also in your Homebridge-Plugin.

English-translation:
Homebridge Webhook wants at current location:
Display all devices: (drop down is active)

All devices

ActionButtons:
Deny Allow

[aaron8151]

Hi @iklein99 ,

I hope you are doing well. I followed all the instruction, but the last step "configure the plugin" in my page is different, there is no "WebhookToken" line, I only see the AccessToken line, can you please help me with this? Thank you!

FYI: I'm using Hoobs, and the version of Smartthings Ik is 1.5.20.

Best,
Aaron

[iklein99]

I can confirm you are working. I looked in my logs and see activity:

11/20/2023, 4:25:21 PM: info: CLIENT REQUEST for aaron8151
11/20/2023, 4:26:46 PM: info: CLIENT REQUEST for aaron8151
11/20/2023, 4:27:22 PM: info: Event(s) detected for user: aaron8151
11/20/2023, 4:27:23 PM: info: CLIENT REQUEST for aaron8151
11/20/2023, 4:28:38 PM: info: Event(s) detected for user: aaron8151
11/20/2023, 4:28:39 PM: info: CLIENT REQUEST for aaron8151
11/20/2023, 4:29:36 PM: info: Event(s) detected for user: aaron8151
11/20/2023, 4:29:36 PM: info: CLIENT REQUEST for aaron8151
11/20/2023, 4:30:10 PM: info: CLIENT REQUEST for aaron8151
11/20/2023, 4:31:17 PM: info: CLIENT REQUEST for aaron8151

Note that the times are UTC.

[aaron8151]

I see, however, that from the Home app, the devices still need about 25 seconds or so to change their status from 'updating'. Do you have any idea why the devices status changes so slowly?

[aaron8151]

[iklein99]

That has nothing to do with the webhook. It is either your Hoobs homebridge running slow or your home hub. If you follow the directions, I will take a look at the timing in your logs.

Instructions for Producing a Detailed Log.pdf

[aaron8151]

I found the problem! I deleted the one device that was offline. All other devices change status right away! THANK YOU!

[iklein99]

Look at the logs. Do you see errors? If not, then you should be able to see by physically changing a device state and see if that change is reflected in the Apple Home app.

[nicofriedrich]

Can u do the same for me? Just see if it is working on your end?
What do u need from me? UserName: nictc

[iklein99]

I see the client requests coming from your homebridge, but no events coming from Smartthings.

[nicofriedrich]

OK I guess I will restart from scratch once more... thx

[iklein99]

YOu need to make sure that the steps to set up the smart app in Smartthings completed properly.

[nicofriedrich-ibm]

So after restart from scratch: Following all steps, I cannot get it to run:
Account: nictc
Looks like smarthtings app + webhook cannot access my devices.
Location: My Home
Count of devices: 7
I can't see any errors in HomeBridge.
Can you help me how to fix it?

What is odd to me is when I click on See all devices I don't see a single one see attached screenshot from your HowTow.

[coryabooth]

Do you have any pihole or some other traffic controller running?

[nicofriedrich-ibm]

no I don't.

[nicofriedrich-ibm]

This is how webhook app looks like in Samsung: SM ^^

[sebtobar]

@nicofriedrich-ibm did you get a solution to this?

@iklein99 I seem to be having the same issue. I’ve set everything up according to the instructions but I can’t see my device (I only have 1, 2 if you count a legacy one that isn’t set up on my ST app)

The device is a robot vacuum, not sure if it’s to do with that.

[montag2k]

Hey Ira!

Thank you for providing this API. I’m signed up (as gogobonobo). I was hoping this would solve the problem I’m having of button events not making it to Homebridge/Homekit, but it looks like even though button presses are showing up in SmartThings, they aren’t making it across.

Is there any way you could check to see if it’s making it over?

[montag2k]

Well I don’t know what I did but it’s working now. Huh.

[iklein99]

Make sure you have a "Home Hub" set up which is separate from Homebridge. I have on running on an old ipad, that I have to restart occasionally.

https://support.apple.com/en-us/HT207057

[montag2k]

Yup I’ve got an AppleTV doing the job. I’m not exactly sure what the problem was but turning on debug mode showed the button events making it to Homebridge, and then all of a sudden it started triggering the event I set up in the Home app.

[coryabooth]

I advise anyone using an iPad as a HomeHub to move to HomePod or Apple TV as the primary hub.

https://9to5mac.com/2022/06/28/apple-says-ipad-can-still-be-a-home-hub-in-ios-16-as-long-as-the-new-homekit-features-dont-matter-to-you/

https://9to5mac.com/2022/06/08/ios-16-homekit-hubs/

[jjeaton]

Any users that have seen a big improvement with the webhook service, could you let me know? I regularly have issues with ST where it thinks everything is working but flipping switches doesn't do anything, until I restart the child bridge. No errors in the log or anything. I only have 2 ST devices, z-wave switch and lock. Just curious if anyone has seen a huge improvement with the webhook