Skip to content
FluentPet Support

Data: Get household events with webhooks and the event feed

Household webhooks send what happens in your household to your own app or service as it happens.

What webhooks are

Section titled “What webhooks are”

A webhook is an address on the internet that FluentPet sends events to. When something happens in your household, for example a Button press, FluentPet sends a message about it to that address. Your app or service can then react to it.

The Home Assistant integration uses a household webhook to receive presses.

Who can use them

Section titled “Who can use them”
  • Only the account that created the household can add and manage webhooks.
  • During the beta, FluentPet turns the feature on for each household. Once it is on, the account that created the household sees the Integrations page on my.fluent.pet.

Add a webhook on my.fluent.pet

Section titled “Add a webhook on my.fluent.pet”
  1. Sign in on my.fluent.pet with the account that created your household.
  2. Open the Integrations page.
  3. Add a webhook and enter its address. The address must be a public address that starts with https://. Addresses on your local network do not work.
  4. Send a test ping to check that your address receives it.

Events FluentPet sends include:

  • Button presses, with the Button and the learner or teacher who pressed it.
  • Interactions, the words pressed together.
  • Changes to your Bases and Buttons, for example a new battery level or a Base that is plugged in or unplugged.
  • Bases, Buttons, learners and teachers that are added, changed or removed.

Every delivery is signed. Your app or service can check the signature to make sure the delivery comes from FluentPet.

Deliveries, retries and automatic disabling

Section titled “Deliveries, retries and automatic disabling”
  • When a delivery fails, FluentPet tries it again.
  • After 20 failed deliveries in a row, FluentPet turns the webhook off. Check that your address is reachable from the internet, then turn the webhook on again on the Integrations page.
  • A household can have at most 5 webhooks. To add another one, delete a webhook you no longer use, for example one left by an earlier Home Assistant installation.

The event feed

Section titled “The event feed”

The event feed lists your household’s events in order. An app or service can read it to catch up on events it missed, for example while it was offline or while its webhook was turned off. Like webhooks, the event feed is only available to the account that created the household.

Instant presses need a plugged-in Base on 1.1.0 or newer

Section titled “Instant presses need a plugged-in Base on 1.1.0 or newer”

A webhook can only send a press once your Base has reported it:

  • A Base that is plugged in and runs firmware 1.1.0 or newer reports presses within seconds.
  • A Base that runs on battery reports presses in batches, minutes later.

Get help

Section titled “Get help”