Τι κάνουν τα webhooks
Ένα webhook είναι μια συνδρομή σε ένα συγκεκριμένο συμβάν καταστήματος. Όταν συμβεί αυτό το συμβάν, το Storeep αποστέλλει αμέσως τα δεδομένα συμβάντος σε έναν σύνδεσμο URL που ορίζετε (τύπος API) ή μια διεύθυνση email που ορίζετε (τύπος E-mail). Τα webhooks χρησιμοποιούνται συνήθως για ενσωματώσεις παρακολούθησης παραγγελιών, συγχρονισμούς CRM, μετατροπές πλατφόρμας διαφημίσεων και αυτόματες ειδοποιήσεις.
Για διαχείριση webhooks, μεταβείτε στις Ρυθμίσεις → Webhooks.
Όρια webhook
- Μέγιστο 20 webhooks ανά κατάστημα. Η προσπάθεια προσθήκης 21ου επιστρέφει σφάλμα.
- Τα webhooks παρατίθενται με νεότερα πρώτα, σελιδοποιημένα σε 40 ανά σελίδα.
Δημιουργία webhook
Κάντε κλικ στο Προσθήκη νέου webhook.
Εναλλαγή ενεργοποίησης
Όταν επιλεγεί (η προεπιλογή), το webhook είναι ζωντανό από τη στιγμή που αποθηκεύεται. Τα συμβάντα αποστέλλονται αμέσως. Αποεπιλέξτε για αποθήκευση του webhook σε απενεργοποιημένη κατάσταση χωρίς λήψη συμβάντων. Μπορείτε να ενεργοποιήσετε ή απενεργοποιήσετε ένα webhook ανά πάσα στιγμή επεξεργαζόμενοι το.
Όνομα
- Υποχρεωτικό.
- Μέγιστο 50 χαρακτήρες.
- Μια περιγραφική ετικέτα που εμφανίζεται στη λίστα webhooks. Παράδειγμα: Facebook CAPI, παραγγελία δημιουργήθηκε.
Τύπος
Ελέγχει πώς παραδίδεται το ωφέλιμο φορτίο συμβάντος. Δύο επιλογές:
- API: το Storeep αποστέλλει αίτημα HTTP POST που φέρει τα δεδομένα συμβάντος στον σύνδεσμο URL που ορίζετε.
- E-mail: το Storeep αποστέλλει email με τα δεδομένα συμβάντος στη διεύθυνση που ορίζετε.
Συμβάν
Το συμβάν καταστήματος που ενεργοποιεί αυτό το webhook. Τρία συμβάντα είναι διαθέσιμα:
- Συνεδρία δημιουργήθηκε: ενεργοποιείται όταν δημιουργείται νέα συνεδρία επισκέπτη στο κατάστημά σας.
- Παραγγελία δημιουργήθηκε: ενεργοποιείται όταν τοποθετείται νέα παραγγελία.
- Παραγγελία ενημερώθηκε: ενεργοποιείται όταν αλλάζει η κατάσταση ή τα δεδομένα υπάρχουσας παραγγελίας.
Μορφή
Η μορφή δεδομένων του ωφέλιμου φορτίου συμβάντος. Τρέχοντα μία επιλογή:
- Json: το ωφέλιμο φορτίο αποστέλλεται ως έγγραφο JSON.
Σύνδεσμος URL (μόνο τύπος API)
- Υποχρεωτικό όταν ο τύπος είναι API.
- Μέγιστο 500 χαρακτήρες. Το υψηλότερο όριο χωράει συνδέσμους URL που περιλαμβάνουν πολλαπλά segments placeholder.
- Εισάγετε τον σύνδεσμο URL τελικού σημείου χωρίς το πρόθεμα
https://. Προστίθεται αυτόματα. Παράδειγμα:api.example.com/events/order. - Δυναμικά placeholders σχεδίου URL: οποιοδήποτε πεδίο από το ωφέλιμο φορτίο συμβάντος μπορεί να εισαχθεί στον σύνδεσμο URL χρησιμοποιώντας σύνταξη διπλών αγκυλών:
{{field_name}}. Για παράδειγμα:https://example.com/postback?cid={{fbclid}}&payout={{order_total}}
Αυτό σάς επιτρέπει να αποστέλλετε δεδομένα μετατροπής σε πλατφόρμες διαφημίσεων απευθείας από τον σύνδεσμο URL webhook χωρίς ξεχωριστό διακομιστή μεσολάβησης. - Αν η δομή URL είναι άκυρη αφού επιλυθούν τα placeholders, θα λάβετε σφάλμα επικύρωσης.
Διεύθυνση email (μόνο τύπος e-mail)
- Υποχρεωτικό όταν ο τύπος είναι E-mail.
- Πρέπει να είναι έγκυρη διεύθυνση email, μέγιστο 127 χαρακτήρες.
Επεξεργασία webhook
Κάντε κλικ σε οποιαδήποτε γραμμή webhook για να ανοίξετε τον επεξεργαστή. Όλα τα πεδία είναι επεξεργάσιμα. Το πεδίο URL προσυμπληρώνεται μόνο αν ο τρέχων τύπος είναι API. Το πεδίο email προσυμπληρώνεται μόνο αν ο τρέχων τύπος είναι E-mail. Η εναλλαγή τύπου καθαρίζει το άλλο πεδίο.
Ενεργοποίηση και απενεργοποίηση webhooks
Το πλαίσιο ελέγχου Ενεργοποίηση στην κορυφή του επεξεργαστή ελέγχει αν ενεργοποιείται το webhook. Η κατάσταση στη λίστα εμφανίζει Ενεργοποιημένο ή Απενεργοποιημένο. Ένα απενεργοποιημένο webhook δεν καταγράφει παραδόσεις αλλά δεν διαγράφεται, οπότε μπορείτε να το ενεργοποιήσετε εκ νέου αργότερα χωρίς νέα διαμόρφωση.
Στήλες λίστας webhooks
- Όνομα: ετικέτα webhook με ημερομηνία δημιουργίας.
- URL / E-mail: η διεύθυνση προορισμού.
- Τύπος: API ή E-mail.
- Συμβάν: το όνομα συμβάντος (Συνεδρία δημιουργήθηκε, Παραγγελία δημιουργήθηκε ή Παραγγελία ενημερώθηκε).
- Μορφή: Json.
- Κατάσταση: Ενεργοποιημένο ή Απενεργοποιημένο.
Διαγραφή webhook
Επιλέξτε ένα ή περισσότερα webhooks και κάντε κλικ στο Διαγραφή webhooks. Αυτό είναι μόνιμο και διακόπτει όλες τις μελλοντικές παραδόσεις για αυτή τη συνδρομή.
Συμβουλές και παγίδες
- Μπορείτε να δημιουργήσετε πολλαπλά webhooks για το ίδιο συμβάν. Για παράδειγμα, αποστολή Παραγγελία δημιουργήθηκε τόσο σε CRM όσο και σε πλατφόρμα διαφημίσεων, καθένα ως ξεχωριστή καταχώρηση webhook.
- Αν το τελικό σημείο σας απαιτεί αυθεντικοποίηση, προσθέστε τα διαπιστευτήρια στο ερώτημα σχεδίου URL χρησιμοποιώντας
{{placeholder}}που προέρχεται από τα δεδομένα συμβάντος, ή ρυθμίστε διακομιστή μεσολάβησης που χειρίζεται την αυθεντικοποίηση πριν προωθήσει στο πραγματικό τελικό σημείο. - Το συμβάν Συνεδρία δημιουργήθηκε ενεργοποιείται για κάθε μοναδική συνεδρία επισκέπτη, που μπορεί να είναι μεγάλης κλίμακας σε δημοφιλή καταστήματα. Συνδρομήστε σε αυτό μόνο αν το τελικό σημείο σας μπορεί να χειριστεί την εισροή.