Webhook - Zmiana parametrów zgłoszenia
Webhook TicketChanged informuje o zmianie parametrów istniejącego zgłoszenia w systemie. Zdarzenie jest wywoływane każdorazowo po modyfikacji zgłoszenia, np. zmianie jego stanu, priorytetu, przypisanego agenta lub innych parametrów.
Na platformie Welyo zdarzenie to odpowiada operacji: Zmiana parametrów zgłoszenia
Webhook może zostać wysłany również w przypadku przypięcia lub przepięcia zgłoszenia do innego rekordu. Identyfikator rekordu jest przekazywany w polu recordId . Jeśli zgłoszenie nie jest powiązane z rekordem, pole to zwróci wartość null .
Webhook może być wykorzystywany m.in. do:
- synchronizacji statusów zgłoszeń z zewnętrznymi systemami (np. CRM lub systemami ticketowymi),
- automatycznego reagowania na zmianę stanu zgłoszenia,
- archiwizacji historii zmian w systemach zewnętrznych.
Struktura zdarzenia
Webhook zawiera podstawowe informacje o zdarzeniu oraz dane dotyczące samego zgłoszenia.
Parametry główne
| Pole | Opis |
|---|---|
| eventName | Nazwa zdarzenia webhooka informująca o zmianie parametrów zgłoszenia |
| fccInstance | Identyfikator instancji systemu(nazwa środowiska) |
| customerId | Identyfikator klienta w systemie Welyo |
| version | Wersja struktury webhooka |
| createdAt | Data i czas wygenerowania zdarzenia |
| data | Obiekt zawierający szczegółowe dane dotyczące zdarzenia |
Struktura pola data dla zdarzenia TicketChanged
| Pole | Opis |
|---|---|
| campaignId | Identyfikator kampanii powiązanej ze zgłoszeniem |
| ticketId | Identyfikator zgłoszenia(w bazie danych) |
| stateId | Identyfikator statusu zgłoszenia |
| priorityId | Identyfikator priorytetu zgłoszenia |
| slaLevelsId | Identyfikator polityki SLA przypisanej do zgłoszenia |
| userId | Identyfikator agenta przypisanego do zgłoszenia |
| subject | Temat zgłoszenia |
| description | Opis zgłoszenia |
| ticketHistoryId | Identyfikator wpisu w historii zgłoszenia |
| typeId | Identyfikator typu zgłoszenia |
| originId | Identyfikator źródła zgłoszenia |
| state | Nazwa statusu zgłoszenia |
| priority | Nazwa priorytetu zgłoszenia |
| slaLevel | Nazwa polityki SLA przypisanej do zgłoszenia |
| type | Nazwa typu zgłoszenia |
| origin | Nazwa źródła zgłoszenia |
| identifier | Identyfikator zgłoszenia(na platformie Welyo) |
| recordId | Identyfikator rekordu powiązanego ze zgłoszeniem |
Przykładowy webhook
{
"eventName": "TicketChanged",
"fccInstance": "vcc1a",
"customerId": 12345,
"version": 1,
"createdAt": "2020-08-25T08:07:12+02:00",
"data": {
"campaignId": 321,
"ticketId": 1145190,
"stateId": 3158,
"priorityId": 373,
"slaLevelsId": 638,
"userId": 10138,
"subject": "test 12?",
"description": "",
"ticketHistoryId": 628811,
"typeId": 5975,
"originId": -3,
"state": "Rozwiązane",
"priority": "Niski",
"slaLevel": "Poziom SLA 1",
"type": "Test typu Zgłoszenia",
"origin": "Mail",
"identifier": "1421342915",
"recordId": 1234
}
}