Before you start: prepare the receiver
The address field in the panel is the last step, not the first. First the receiver must exist and accept JSON requests over HTTPS. A typical receiver is a workflow in the n8n tool that publishes entries in a plant channel in Mattermost or Telegram.
Events are sent with a 5-second time limit, so the receiver should respond quickly and perform heavier processing after returning its response. A receiver that answers after 8 seconds will be seen as unavailable.
- An address of the receiver reachable from the plant's application server.
- A channel in the chat tool where the entries should appear.
- A person who will confirm the entries on the security side.
- Consent from the IT department for traffic to the receiver's address.
Steps 1 and 2: enter the address in the panel
The administrator opens the integration settings in the panel and finds the webhook:reception_url field. They enter the full receiver address, with protocol and path, and save the setting. An empty field means nothing is sent, so clearing the address is also how the integration is switched off.
The change applies to subsequent events. Events created before the address was saved are not sent retroactively, so no history should be expected in the channel.
What to enter and what to avoid
Enter the destination address, not a redirecting address. Do not put authentication credentials in plain text in the address if the receiver supports a separate secret. Rules for securing the receiver are described in the material on good practices.
Six event types by stage of the visit
Step 3: register a test guest
To trigger the first event, register a test guest at a station or in the panel. The guest_registered event should appear in the channel within a few seconds. The guest registration event deliberately does not carry a phone number, so its absence from the entry is expected.
The entry should contain the ready text from the system and the time of the event in the Europe/Warsaw time zone in ISO 8601 format. If the time looks shifted, check whether the receiver is converting it again to its own time zone.
Steps 4 and 5: check group events and the alert
The webhook publishes six event types, so testing one type does not prove that the others work. Also trigger a group training event: a group at a registration station lives for 34 minutes, and after that time, or after an abort, the receiver gets the failure event.
Check how the entries behave. An entry about a group in progress should be replaced by a new one, and when a group is aborted or fails, a red entry with a sound should appear. If the channel fills with repetitions, the receiver workflow does not replace entries and needs fixing.
Check that the alert is not duplicated
The training failure alert is protected against duplicates by a SET NX marker in Redis. If you still see two entries, check whether the receiver processes the same request twice on its own service side.
Step 6: check the behaviour when the receiver fails
Events are placed on a queue and sent asynchronously, and a webhook error does not interrupt guest registration, scanning or completion of training. It is worth checking this deliberately: switch the receiver off for a while, register a test guest and make sure that reception works normally.
After the receiver is restored, register another guest and confirm that the entries return. Record the result of the test in the acceptance protocol, so that you can return to it if doubts arise after a configuration change.
Common problems and diagnosis
The most common reason for a missing entry is an address that the application server cannot reach on the plant network. If the network blocks outgoing traffic from the application host, consider the delivery mode with the messages collected by a poller, described in the material on choosing direct or outbox mode.
The second reason is a receiver that responds in more than 5 seconds. The third is an empty or incorrectly saved value in the webhook:reception_url field. Start the diagnosis with the simplest check: open the setting, check the address and trigger a test event.
Checklist
Video
Frequently asked questions
Where is the reception webhook address entered?
In the panel, in the webhook:reception_url field. An empty field means that no event is sent.
Will events created before the address was saved be sent?
No. The change applies to events created after saving, so the history in the channel starts from the first registration after configuration.
What should I do when the plant network blocks outgoing traffic?
Consider outbox mode, in which the poller collects messages through an incoming channel. Details are in the material on choosing direct or outbox mode.
Let us configure the webhook together
In a demo we will walk through the whole process, from an empty field to an entry in the chat tool channel. Book a meeting with the InnerWeb team.
Let's talk