update webhooks figures (#401)
gijsio
GitHub
@@ -11,3 +11,5 @@ Pybytes offers a way to interact with external IoT platform or custom services,
|
||||
* [Microsoft Azure](azure): a comprehensive collection of services and solutions designed to help you create end-to-end IoT applications on Azure
|
||||
* [Google Cloud IoT](google): a complete set of tools to connect, process, store, and analyse data, both at the edge and in the cloud
|
||||
* [Web Hooks](webhooks): this allows for user-defined HTTP callbacks to a defined remote destination. All elements of the requests (headers, query string parameters, etc) are customisable
|
||||
|
||||
)
|
||||
@@ -10,22 +10,29 @@ You can use some presets (`DEVICE_TOKEN`, `USER_ID`, etc), which will act like p
|
||||
|
||||
## Integrate your devices
|
||||
|
||||
In the sidebar, click on _New Integration_ and then on _Webhook_
|
||||
1. In the sidebar, click on _Integrations_, _New Integration_ and then on _Webhook_
|
||||
|
||||
|
||||
|
||||
Fill in the form specifying the following information:
|
||||
1. The remote URL to which we will send the data
|
||||
2. An event name
|
||||
3. The HTTP method
|
||||
4. The request format. Please note that we will pre-fill some headers whenever you change the format. The pre-filled headers are not modifiable.
|
||||
5. You can optionally add some more headers and query parameters. There's also an eased interface for basic HTTP authentication.
|
||||
1. Fill in the form specifying the following information: (for this example, you can leave the default settings)
|
||||
* The remote URL to which we will send the data, in this example, we will use a custom URL generated on [webhook.site](https://webhook.site/), paste `Your unique URL` in the textbox.
|
||||
* An event name
|
||||
* The HTTP method
|
||||
* The request format. Please note that we will pre-fill some headers whenever you change the format. The pre-filled headers are not modifiable.
|
||||
* You can optionally add some more headers and query parameters. There's also an eased interface for basic HTTP authentication.
|
||||
|
||||
We will take care of formatting the body accordingly to the chosen request format. In case you've chosen _Custom Body_, you'll have to define everything yourself. You'll also be able to manually insert the presets.
|
||||
Once you're done, you'll see a preview of the request at the bottom of the page. Remember to choose the devices you want to bind to this service.
|
||||
2. We will take care of formatting the body accordingly to the chosen request format. In case you've chosen _Custom Body_, you'll have to define everything yourself. You'll also be able to manually insert the presets.
|
||||
|
||||
|
||||
|
||||
If everything's worked as expected, you should be able to see a summary of your integration, similar to the following:
|
||||
3. Once you're done, you'll see a preview of the request at the bottom of the page. Remember to choose the devices you want to bind to this service.
|
||||
|
||||
4. If everything's worked as expected, you should be able to see a summary of your integration, similar to the following:
|
||||
|
||||
|
||||
|
||||
5. Setup the selected device to [Visualize signals](/pybytes/dashboard/) and view the webhook site you generated. If all went correctly, you should see the samples arrive there:
|
||||
|
||||
|
||||
|
||||
Now you should be able to adjust the settings and forward the data to your own service or app and work with the Pybytes signals
|
||||
|
After Width: | Height: | Size: 156 KiB |
|
Before Width: | Height: | Size: 322 KiB After Width: | Height: | Size: 180 KiB |
|
Before Width: | Height: | Size: 431 KiB After Width: | Height: | Size: 194 KiB |
|
Before Width: | Height: | Size: 836 KiB After Width: | Height: | Size: 186 KiB |
|
After Width: | Height: | Size: 223 KiB |