Webhooks
SurveyLab umożliwia integrację poprzez webhooks. Dzięki temu możesz wywołać ankietę w oparciu o dowolne zdarzenie (np. zakończenie rozmowy na chat) w innym systemie. W ten sposób możesz stworzyć integrację z dowolnym narzędziem lub serwisem (np. CRM, eshop, chat online).
Lista dostępnych zadań
- Dodanie respondenta (adresu email) do listy kontaktów
- Dodanie dowolnej informacji do ankiety
Dodaj respondentów do listy kontaktów
Ta funkcjonalność pozwala dynamicznie aktualizować listę kontaktów dla wybranego kolektora. Funkcjonalność działa zarówno w przypadku zamkniętych jak i aktywnych kolektorów. Jeśli kolektor jest aktywny system automatycznie wyśle zaproszenia do wypełnienia ankiety dla nowo dodanych kontaktów.
Kody statusów
Statusy są zwracane za pomocą standardowych kodów błędów HTTPS.
Kod | Opis |
---|---|
200 | OK. Zapytania zostało wykonane pomyślnie. |
400 | Bad request. Zapytanie nie powiodło się. Błędny token. |
401 | Unauthorized. Próbujesz zautoryzować się za pomocą błędnego loginu lub klucza API. |
404 | Not Found. Zasób nie istnieje. |
429 | Zbyt wiele zapytań. |
500 | Internal Server Error. Spróbuj ponownie lub skontaktuj się z naszym wsparciem. |
Struktura URL
https://app.surveylab.com/api.php?apiToken=[TOKEN]&cId=[COLLECTOR ID]&email=[RESPONDENT EMAIL]&crk=[CRK DATA]&referrer=[RESPONDENT DATA]&language=[SURVEY LANGUAGE]
Komunikaty błędów
Akcja zakończona sukcesem : {„status”:true,”notification”:”Action processed correctly”}
Akcja zakończona niepowodzeniem : {„status”:false,”notification”:”Action failed”}
Dostępne parametry
Możesz wykorzystać wszystkie lub wybrane parametry. apiToken, cId, email i crk są wymagane.
Parametr | Przykład | Opis |
---|---|---|
apiToken | apiToken=[TOKEN] | Wymagany. Token. |
cId | cld=[COLLECTOR ID] | Wymagany. ID kolektora. |
email=[RESPONDENT EMAIL] | Wymagany. Email respondenta. | |
crk | crk=[CRK DATA] | Wymagany. Unikalny Klucz odpowiedzi użytkownika (crk). |
referrer | referrer=[RESPONDENT DATA] | Opcjonalny. Referrer może zawierać dowolne dane lub informacje. |
language | language=[SURVEY LANGUAGE] | Opcjonalny. Ustawienie język ankiety. Wymaga dodania wersji językowych ankiety. |
phone | phone=[PHONE] | Opcjonalny. Telefon. |
firstName | firstName=[NAME] | Opcjonalny. Imię. |
lastName | lastName=[SURNAME] | Opcjonalny. Nazwisko. |
custom1 | custom1=[CUSTOM1] | Opcjonalny. Dodatkowe informacje 1. |
custom2 | custom2=[CUSTOM2] | Opcjonalny. Dodatkowe informacje 2. |
custom3 | custom3=[CUSTOM3] | Opcjonalny. Dodatkowe informacje 3. |
custom4 | custom4=[CUSTOM4] | Opcjonalny. Dodatkowe informacje 4. |
custom5 | custom5=[CUSTOM5] | Opcjonalny. Dodatkowe informacje 5. |
custom6 | custom6=[CUSTOM6] | Opcjonalny. Dodatkowe informacje 6. |
custom7 | custom7=[CUSTOM7] | Opcjonalny. Dodatkowe informacje 7. |
custom8 | custom1=[CUSTOM8] | Opcjonalny. Dodatkowe informacje 8. |
Przykład
UWAGI. Klucz odpowiedzi musi być unikalny dla każdego zaproszenia do wypełnienia ankiety.
Aby pobrać API token :
- Przejdź do Ustawień konta.
- Wybierz Integracje.
- Skopiuj wartość z pozycji TOKEN API SURVEYLAB.
Przekazane dane są dostępne w raportach ankiet (szczegółowy raport, wszystkie formaty).
UWAGI. Webhook to natychmiastowe powiadomienie o danym zdarzeniu np. zakończenie rozmowy prowadzonej na chat lub zamknięcie ticketu obsługowego. Takie powiadomienie może być przekazane za pomocą protokołu HTTP / HTTPS. Przeczytaj więcej o na Wikipedia.
Funkcjonalność dostępna jest dla kont Professional i Enterprise.