Bundeling

Webhook

Introduction

Webhooks can communicate between web applications. It will send data between the applications whenever the given event is triggered.
For example a webhook can be used to alert your app when data is updated, so your app can be updated to the latest data.

Example

The example on this page will explain what happens when a webhook is triggered.
First part shows the webhook that is triggered. Second part shows which information will be received by you.
The webhook in the example gives back that an user profile is updated. It gives back which object has triggered the webhook and which webhook was triggered.

Events explained

The events that can be used with a webhook are described in the table below.
Add, save and delete can be used with every object_type.

Event name	Description	Example
add	Triggers when an add event is executed	A new user profile is added. Data will be send
save	Triggers when a save event is executed	An user profile is updated. Data will be send
delete	Triggers when a delete event is executed	An user profile is deleted. Data will be send
activated	Triggers when an activated event is executed in BulletinBoardItem	A BulletinBoardItem is activated. Data will be send
canceled	Triggers when a canceled event is executed in Event	A planned event is canceled. Data will be send
form_submitted	Triggers when a form_submitted event is executed in FormData	A form is submitted. Data will be send
score_set	Triggers when score_set event is executed in Match	A score_set is made in match. Data will be send

Object types

Webhooks can be made on different object types. These object types can be found at create in the endpoint Webhooks.

Json

XML

Example webhook

An user updates twitter profile at user profile in Bundeling app.
The webhook that will be triggered when the update is executed:

{
    "uuid": "eeb763c41c054dcc8f6d9362f24ee9b2",
    "name": "User update",
    "object_type": "user",
    "event": "save",
    "endpoint": "https://example.com/webhook_callback",
    "creationdate": "2021-10-15T00:00:00+0000",
    "lastupdate": "2021-10-15T00:00:00+0000"
}

The data that will be received is:

{
    "webhook_uuid": "eeb763c41c054dcc8f6d9362f24ee9b2",
    "webhook_name": "user update",
    "object_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "object_type": "User",
    "event": "save",
    "object_endpoint": "https://api.bundeling.com/v2/users/d7743aaf53224e279853c7d0c1dbfb3a"
}