Files
pycom-documentation/content/pybytes/integrations/webhooks.md
jirikrepl ad6f52237b Fixed all typos from Lily's branch.
Used correct HEAD of publish branch as a base of this branch
Applied just text (typo) changes
2019-10-17 12:49:42 +02:00

1.7 KiB

title, aliases
title aliases
Webhooks
pybytes/integrations/webhooks.html
pybytes/integrations/webhooks.md

Whenever one of your integrated devices sends a signal to Pybytes, we perform an HTTP request defined by the user. You can use some presets (DEVICE_TOKEN, USER_ID, etc), which will act like placeholders and will be dynamically replaced at the moment of performing the request with the relative content.

Integrate your devices

In the sidebar, click on New Integration and then on Webhook

New WebHook integration

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.

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.

Webhook definition

If everything's worked as expected, you should be able to see a summary of your integration, similar to the following:

Creation process result