Μετάβαση στο περιεχόμενο
Rex, ο βοηθός AI σας: αναλαμβάνει τη ρουτίνα, οι ιδέες μένουν δικές σας 👉 Γνωρίστε τον Rex

Στείλτε δεδομένα στα συστήματά σας με webhooks

Λάβετε ένα αίτημα στο δικό σας URL όταν κάποιος εγγράφεται, συμμετέχει ή κερδίζει, με υπογεγραμμένο payload, basic auth, προσαρμοσμένο payload και αρχείο καταγραφής για κάθε αποστολή.

Ένα webhook στέλνει δεδομένα σε ένα URL της επιλογής σας τη στιγμή που συμβαίνει κάτι, για παράδειγμα όταν κάποιος συμμετέχει σε μια καμπάνια ή κερδίζει ένα έπαθλο. Ο προγραμματιστής σας ρυθμίζει το σύστημα που τα λαμβάνει.

Τα webhooks περιλαμβάνονται στα πακέτα που διαθέτουν Webhooks & API (Basic και άνω).

Webhooks καμπάνιας ή webhooks λογαριασμού;

  • Τα webhooks καμπάνιας ρυθμίζονται στον επεξεργαστή καμπάνιας και ενεργοποιούνται μόνο για τη συγκεκριμένη καμπάνια. Διαθέτουν τα συμβάντα «Every time a lead participates in a campaign» και «When a lead wins a prize», καθώς και τις περισσότερες επιλογές.
  • Τα webhooks λογαριασμού ρυθμίζονται στις Settings > Webhooks. Διαθέτουν το συμβάν «When a new lead is created»: ενεργοποιείται μία φορά ανά άτομο, την πρώτη φορά που προστίθεται στα leads σας, από όποια καμπάνια κι αν προέρχεται.

Προσθήκη webhook σε καμπάνια

  1. Ανοίξτε την καμπάνια στον επεξεργαστή και μεταβείτε στο Connect > Webhooks.
  2. Κάντε κλικ στο Add webhook.
  3. Εισαγάγετε το Payload URL. Πρέπει να ξεκινά με https: «We only support webhooks over HTTPS to ensure that the data sent remains secure.»
  4. Επιλέξτε το Content type: application/json ή application/x-www-form-urlencoded.
  5. Επιλέξτε τη Method. Η φόρμα ξεκινά με GET, που στέλνει τα δεδομένα μέσα στο URL. Επιλέξτε POST για να τα στείλετε στο σώμα του αιτήματος, όπως περιμένουν τα περισσότερα συστήματα.
  6. Στην ενότητα Authentication (μόνο για POST), επιλέξτε Basic Auth αν το URL σας απαιτεί όνομα χρήστη και κωδικό πρόσβασης και συμπληρώστε τα πεδία Username και Password. Διαφορετικά, αφήστε την επιλογή None.
  7. Εισαγάγετε ένα Secret για την υπογραφή των αιτημάτων (συνιστάται). Δείτε την ενότητα «Έλεγχος της υπογραφής» παρακάτω.
  8. Ενεργοποιήστε το Log response body αν θέλετε να βλέπετε τι απαντά το σύστημά σας. «Enable to store the response body for debugging.»
  9. Αφήστε ενεργοποιημένο το Active. «We will only deliver events if the webhook is active.»
  10. Επιλέξτε το συμβάν: «Every time a lead participates in a campaign» ή «When a lead wins a prize».
  11. Ενεργοποιήστε το Custom payload αν θέλετε να ορίσετε μόνοι σας τα πεδία (δείτε παρακάτω).
  12. Κάντε κλικ στο Add webhook. Θα εμφανιστεί το μήνυμα «Webhook added».

Το πλαίσιο Webhooks εμφανίζει τα webhooks της καμπάνιας με την ένδειξη Active ή Inactive, καθώς και Last delivery failed αν το τελευταίο αίτημα απέτυχε. Από τις Actions μπορείτε να επιλέξετε Edit, See deliveries ή Delete για ένα webhook. Όταν επεξεργάζεστε ένα webhook, αφήστε κενό το Secret για να διατηρήσετε το υπάρχον.

Προσθήκη webhook λογαριασμού

  1. Μεταβείτε στις Settings > Webhooks (στην ενότητα Developers). Τα webhooks σας εμφανίζονται στο My webhooks (ή κάτω από το όνομα κάθε λίστας leads, αν έχετε περισσότερες).
  2. Κάντε κλικ στην κάρτα με το σύμβολο συν για να προσθέσετε ένα webhook. Το παράθυρο Add webhook αναφέρει «Send a request to an external URL whenever selected events happen.»
  3. Συμπληρώστε τα πεδία Payload URL, Content type («Select content type of the webhook»), Method και Secret όπως παραπάνω.
  4. Στην ενότητα Which events should trigger the webhook?, επιλέξτε «When a new lead is created».
  5. Τσεκάρετε το «Yes, allow me to specify a customized payload (Advanced users only)» αν θέλετε δικά σας πεδία.
  6. Τσεκάρετε το Log response body («This webhook will log the response body») αν χρειάζεται και αφήστε τσεκαρισμένο το Active («We will deliver event details when this hook is triggered»).
  7. Κάντε κλικ στο Add webhook.

Κάντε κλικ σε ένα webhook για να το αλλάξετε (Αποθήκευση αλλαγών), να ορίσετε ένα New secret, να ανοίξετε το Show deliveries ή να επιλέξετε Delete webhook («This action cannot be reverted!»).

Τι αποστέλλεται

Από προεπιλογή, το σώμα περιέχει ένα event (το όνομα του συμβάντος: lead_created_on_campaign, new_campaign_winner ή lead_created) και ένα αντικείμενο data:

  • campaign: το id και το name της καμπάνιας (webhooks καμπάνιας)
  • lead: τα πεδία φόρμας του lead με βάση το κλειδί τους (για παράδειγμα first_name), καθώς και τα id, phone_number και created_at
  • lead.permissions: για κάθε πλαίσιο συγκατάθεσης, αν έγινε αποδεκτό, το κείμενο, η ημερομηνία και η διεύθυνση IP (webhooks καμπάνιας)
  • participant: το channel από το οποίο ήρθε το άτομο και πότε συμμετείχε (webhooks καμπάνιας)
  • quiz: οι απαντήσεις στις ονομασμένες ερωτήσεις του κουίζ, καθώς και με ευανάγνωστα ονόματα που ξεκινούν με «Simple»
  • prize: τα id, name, value, coupon_code του επάθλου και πότε κερδήθηκε (webhooks νικητών)

Οι κενές τιμές παραλείπονται, όπως και οι συγκαταθέσεις που δεν έγιναν αποδεκτές. Με τη μέθοδο GET, τα ίδια δεδομένα αποστέλλονται ως παράμετροι ερωτήματος στο URL.

Προσαρμοσμένο payload

Με ενεργοποιημένο το Custom payload, αποστέλλονται μόνο τα πεδία που επιλέγετε, χωρίς το περιτύλιγμα event.

  1. Στην ενότητα Data mapping, κάντε κλικ στο Add mapping.
  2. Πληκτρολογήστε το Field name που περιμένει το σύστημά σας. Χρησιμοποιήστε γράμματα, αριθμούς, παύλες και κάτω παύλες.
  3. Επιλέξτε το πεδίο του Scratcher που θα αποσταλεί («Group → Field») ή το Custom value και πληκτρολογήστε μια σταθερή Value.
  4. Επαναλάβετε για κάθε πεδίο. Αφαιρέστε ένα πεδίο με τον κάδο (Remove ή Remove data mapping).

Έλεγχος της υπογραφής

Αν ορίσετε secret, κάθε αίτημα περιέχει την κεφαλίδα X-Hub-Signature: sha1= ακολουθούμενο από ένα hash HMAC-SHA1 του payload σε μορφή JSON (το σώμα όπως περιγράφεται παραπάνω), με το secret σας ως κλειδί. Υπολογίστε το ίδιο από τη δική σας πλευρά και συγκρίνετε, για να βεβαιωθείτε ότι το αίτημα προήλθε από το Scratcher.

Αποστολές και επαναλήψεις

  • Αν το URL σας δεν απαντά ή επιστρέφει σφάλμα (κωδικός κατάστασης 400 ή μεγαλύτερος), το Scratcher δοκιμάζει ξανά δύο φορές: μετά από 5 δευτερόλεπτα και μετά από ένα λεπτό.
  • Οι ανακατευθύνσεις δεν ακολουθούνται, οπότε χρησιμοποιήστε το τελικό URL.
  • Ανοίξτε τις αποστολές (See deliveries στην καμπάνια, Show deliveries για τα webhooks λογαριασμού) για να δείτε κάθε αίτημα και απόκριση. Κάθε αποστολή εμφανίζει το ID, το Request και το Response με τον κωδικό κατάστασης (και το Response body, αν το καταγράφετε). Χρησιμοποιήστε το copy για να αντιγράψετε ένα payload.
  • Ενεργοποιήστε το Show only failed deliveries για να βλέπετε μόνο τα προβλήματα. Στο επάνω μέρος εμφανίζεται «Failed deliveries in the last 60 days».
  • Κάντε κλικ στο Retry για να στείλετε ξανά μια αποστολή: «The webhook is being resent.»
  • «Webhook delivery logs are retained for 60 days.»

Αντιμετώπιση προβλημάτων

  • «The ... field must use HTTPS.»: το Payload URL ξεκινά με http. Χρησιμοποιήστε https.
  • Όλες οι αποστολές αποτυγχάνουν χωρίς απόκριση: το URL δεν είναι προσβάσιμο από το διαδίκτυο, για παράδειγμα επειδή είναι τοπική ή εσωτερική διεύθυνση. Χρησιμοποιήστε ένα δημόσιο URL.
  • Το σύστημά σας δεν λαμβάνει δεδομένα: η μέθοδος είναι GET, οπότε τα δεδομένα βρίσκονται στο URL. Αλλάξτε σε POST.
  • Λείπει ένα πεδίο που περιμένει το σύστημά σας: ήταν κενό ή η συγκατάθεση δεν έγινε αποδεκτή. Ρυθμίστε το σύστημά σας ώστε να αντιμετωπίζει τα πεδία που λείπουν ως κενά.
Χρειάζεστε βοήθεια;

Χρειάζεστε ακόμη βοήθεια;

Πραγματικοί άνθρωποι είναι εδώ για να βοηθήσουν. Αν ήδη χρησιμοποιείτε το Scratcher, ο πιο γρήγορος τρόπος είναι η συνομιλία μέσα στην πλατφόρμα.

  • Συνομιλήστε μαζί μας

    Συνδεθείτε και πατήστε το κουμπί συνομιλίας κάτω δεξιά. Ο Rex απαντά αμέσως και η ομάδα μας είναι ένα κλικ μακριά.

  • Κλείστε ραντεβού

    Μια δωρεάν βιντεοκλήση 30 λεπτών με την ομάδα μας: περιήγηση, ιδέες για καμπάνιες ή βοήθεια με τη ρύθμιση.

  • Στείλτε μας email

    Γράψτε στο contact@scratcher.io και θα σας απαντήσουμε.