diff --git a/content/pybytes/integrations/_index.md b/content/pybytes/integrations/_index.md index c11922e..43e2f6b 100644 --- a/content/pybytes/integrations/_index.md +++ b/content/pybytes/integrations/_index.md @@ -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 + +![](/gitbook/assets/pybytes/integrations/select-new-integration.png)) \ No newline at end of file diff --git a/content/pybytes/integrations/webhooks.md b/content/pybytes/integrations/webhooks.md index ac42003..7d28674 100644 --- a/content/pybytes/integrations/webhooks.md +++ b/content/pybytes/integrations/webhooks.md @@ -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_ ![New WebHook integration](/gitbook/assets/pybytes/integrations/webhook/select-webhook-integration.png) -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. ![Webhook definition](/gitbook/assets/pybytes/integrations/webhook/webhook-form.png) -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: ![Creation process result](/gitbook/assets/pybytes/integrations/webhook/webhook-inspector.png) + +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: + +![](/gitbook/assets/pybytes/integrations/webhook/webhook-view.png) + +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 \ No newline at end of file diff --git a/static/gitbook/assets/pybytes/integrations/select-new-integration.png b/static/gitbook/assets/pybytes/integrations/select-new-integration.png new file mode 100644 index 0000000..25fd94e Binary files /dev/null and b/static/gitbook/assets/pybytes/integrations/select-new-integration.png differ diff --git a/static/gitbook/assets/pybytes/integrations/webhook/select-webhook-integration.png b/static/gitbook/assets/pybytes/integrations/webhook/select-webhook-integration.png index bdabdda..2a8bddf 100644 Binary files a/static/gitbook/assets/pybytes/integrations/webhook/select-webhook-integration.png and b/static/gitbook/assets/pybytes/integrations/webhook/select-webhook-integration.png differ diff --git a/static/gitbook/assets/pybytes/integrations/webhook/webhook-form.png b/static/gitbook/assets/pybytes/integrations/webhook/webhook-form.png index d74fc73..6ff43a3 100644 Binary files a/static/gitbook/assets/pybytes/integrations/webhook/webhook-form.png and b/static/gitbook/assets/pybytes/integrations/webhook/webhook-form.png differ diff --git a/static/gitbook/assets/pybytes/integrations/webhook/webhook-inspector.png b/static/gitbook/assets/pybytes/integrations/webhook/webhook-inspector.png index 092eaed..b9b767b 100644 Binary files a/static/gitbook/assets/pybytes/integrations/webhook/webhook-inspector.png and b/static/gitbook/assets/pybytes/integrations/webhook/webhook-inspector.png differ diff --git a/static/gitbook/assets/pybytes/integrations/webhook/webhook-view.png b/static/gitbook/assets/pybytes/integrations/webhook/webhook-view.png new file mode 100644 index 0000000..a86cb68 Binary files /dev/null and b/static/gitbook/assets/pybytes/integrations/webhook/webhook-view.png differ