Routers
You only need this resource for sending webhooks, not for receiving them!
A Router exposes webhook messages and topics to the external world.
When a webhook message is sent to a certain topic, all routers that route that topic will deliver the message to its subscribers.
The routing process is illustrated by the following diagram. It starts with a webhook being published:
In the diagam, the first step when a webhook is published is to find all routers. Those routers will then be matched against a filtering criteria and the ones that pass the filtering will proceed to the next step.
The last step is then to send the webhook to all the subscribers of each router that passed the filtering. This step is depicted here as only one step for the sake of simplification, but it includes its own sub-steps. You can see how the full routing of a webhook works in the Routing page.
Filtering criteria
A router acts as a filter, determining to whom a webhook will be delivered. The filtering is run for each router. It follows these steps:
First: the routers's allowed_topics must include the webhook topic
parameter.
Second: if the webhook was published with the include_tags optional parameter,
then at least one of the routers's tags must also be present in the
include_tags parameter.
Third: if the webhook was published with the exclude_tags optional parameter,
the router's tags must not contain any tag included in the
exclude_tags parameter.
If all three criteria above pass, the subscribers associated to the router will then receive the published webhook.
The second a third steps include preconditions ("if the webhook..."). If the preconditions evaluate to false, the step is considered as passed. Please Using tags section if you are in doubt about this.