Przejdź do treści

Webhooki – integracja z innymi aplikacjami

Jednym z rozwijanych przez nas elementów systemu jest integracja Konfeo z zewnętrznymi aplikacjami. W tym zakresie wprowadziliśmy właśnie możliwość wysyłania przez system webhooków.

Czym są webhooki?

Webhooki to – w uproszczeniu – automatyczne wiadomości wysyłane z jednej aplikacji do drugiej, gdy zachodzi jakieś konkretne zdarzenie. Przypominają powiadomienia SMS wysyłane przez twój bank, np. po otrzymaniu płatności:

  • akcja – przychodzi przelew od klienta
  • reakcja banku – wysłanie SMS na Twój numer telefonu

Zasada działania webhooków jest identyczna. W ten sposób Konfeo może wysyłać automatyczne powiadomienia do innej aplikacji, gdy w systemie zaistnieje któreś z poniższych zdarzeń, skutkujące zmianą statusu uczestnika na Zaakceptowany:

  • uczestnik zarejestruje się na bezpłatne wydarzenie
  • uczestnik zapłaci za płatne wydarzenie

Jaka jest struktura webhooków?

Webhooki wysyłane przez Konfeo zawierają: imię i nazwisko, adres e-mail, tytuł wydarzenia, nazwę biletu/grupy, cenę i walutę, informacje o dodatkowych uczestnikach oraz dane z dodatkowych pól formularza utworzonych przez organizatora wydarzenia.

Struktura webhooków wygląda następująco:

{
    "type": "attendee_accepted",
    "attendee": {
        "id": 123,
        "name": "John",
        "surname": "Doe",
        "email": "john@doe.com"
    },
    "fee": {
        "price": 123.45,
        "currency": "USD"
    },
    "event": {
        "id": 234,
        "name": "Event name"
    },
    "group": {
        "id": 345,
        "name": "Group name"
    },
    "form_fields": [
        {
            "id": 45,
            "type": "text",
            "label": "Phone",
            "value": "123 456 789"
        },
        {
            "id": 46,
            "type": "text_area",
            "label": "Bio",
            "value": "Text"
        },
        {
            "id": 47,
            "type": "select",
            "label": "Food type",
            "value": "vegetarian"
        },
        {
            "id": 48,
            "type": "select",
            "label": "Weather",
            "value": null
        },
        {
            "id": 49,
            "type": "radio",
            "label": "T-shirt size",
            "value": "L"
        },
        {
            "id": 50,
            "type": "check_box",
            "label": "Newsletter",
            "value": true
        },
        {
            "id": 51,
            "type": "check_box",
            "label": "Marketing",
            "value": false
        }
    ],
    "additional_attendees": [
        {
            "id": 124,
            "name": "Jane",
            "surname": "Doe"
        }
    ]
}

Jak uruchomić wysyłanie webhooków?

Uruchomienie wysyłki webhooków jest bardzo proste – wystarczy podać w zakładce Ustawienia wydarzenia | Webhooki adres URL, na który Konfeo ma je wysyłać. To wszystko.