Webhook - Dodanie pojedynczego rekordu do kampanii
Zdarzenie RecordCreated informuje o utworzeniu nowego rekordu w kampanii. Webhook jest wywoływany w momencie ręcznego dodania pojedynczego rekordu przez użytkownika na platformie Welyo.
📌 Zdarzenie nie jest generowane w przypadku dodania rekordów przez EAPI ani przez import danych.
Na platformie Welyo zdarzenie to odpowiada operacji - Dodanie pojedynczego rekordu do kampanii.
Webhook może być wykorzystywany np. do:
- synchronizacji danych z zewnętrznym systemem CRM,
- uruchamiania dodatkowych procesów po dodaniu rekordu,
- archiwizacji lub analizy danych w systemach zewnętrznych.
Struktura zdarzenia
Webhook zawiera podstawowe informacje o zdarzeniu oraz dane dotyczące utworzonego rekordu.
Parametry główne
| Pole | Opis |
|---|---|
| eventName | Nazwa zdarzenia webhooka informująca o dodaniu rekordu |
| 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 RecordCreated
| Pole | Opis |
|---|---|
| campaignId | Identyfikator kampanii, do której dodano rekord |
| recordId | Identyfikator utworzonego rekordu |
| userId | Identyfikator użytkownika, który dodał rekord |
| emails | Tablica adresów e-mail przypisanych do rekordu |
| numbers | Tablica numerów telefonów przypisanych do rekordu |
| fields | Pola rekordu wraz z ich wartościami |
| language | Język przypisany do rekordu |
| weight | Ważność rekordu |
Przykładowy webhook
{
"eventName": "RecordCreated",
"fccInstance": "vcc1a",
"customerId": 12345,
"version": 1,
"createdAt": "2020-08-25T08:01:48+02:00",
"data": {
"campaignId": 321,
"recordId": 555,
"userId": 7,
"emails": [
"bok@focustelecom.pl"
],
"numbers": [
"222289289"
],
"fields": {
"Pole_rekordu_1": "test 1",
"Pole_rekordu_2": "test 2"
},
"language": "pl",
"weight": 0
}
}