This article is also available in:
Users' webhooks

In Flokzu you can share the information about events that happen about your users with external systems through webhooks.
Webhooks provide a mechanism to notify your application when a certain event that affects a user occurs so that you can take action.

At Flokzu there are several events that can be taken into account when setting up user webhooks:

When a user is invited to Flokzu
When a user accepts the invitation and becomes an active user
When a user unsubscribes from the e-mails.
When the user is deleted.
When the user name or alias is modified.
When the substitution is added, modified or removed.
When the user logs in to Flokzu.

The actions in your system will depend on what you want and you will have to configure the URL to execute it.

How do webhooks work?
Imagine a bell system, it includes a button on the door and a bell in your living room.
When a person presses the button, the bell rings in the room, informing you that someone is at the door - that is, a signal is sent from the button to the doorbell.
In this example: someone will come to the door and press the button, the bell will hear the button and ring.

Webhooks work the same way, the door will be Flokzu, the button will be the event that happens in Flokzu and the bell the system that you notify of that event.
For the webhooks: An event associated to a user will happen in Flokzu, the other system will listen to that event and perform an action based on it, for example Update data.

Webhook: user:create
A webhook set up for the user:create event will be executed when a user is invited to Flokzu.

The format for each Json sent to the service is the following:


Alias is the email alias defined by the user in his profile.

Webhook: user:update
A webhooks set up for the user:update event will be executed in case any of the following actions happen:
When a user accepts the invitation and becomes an active user.
When a user unsubscribes from the mails.
When the user is deleted.
When the user name or alias is modified.

The format for each Json sent to the service is the following:



WebHook user:out-of-office
A webhook set up for the user:out-of-office event will be executed when a user is added, modified or removed.

The format for each Json sent to the service is as follows:



When you delete a substitution you must send the payload with action Deleted and with the substitute, start and end data as empty strings. In case the substitution is changed the action will be Updated.

WebHook user:login
A webhook set up for the user:login event will be executed when a user logs in to Flokzu.

The format for each Json sent to the service is the following:



Set up webhooks

User webhooks must be defined in Advanced Settings section.



The current version does not provide for a retry policy. To ensure data integrity in your implementation, you can use the event timestamp.
Was this article helpful?
Cancel
Thank you!