OptiMES

  1. Home
  2. Docs
  3. OptiMES
  4. Dokumentacja użytkownika
  5. Ustawienia
  6. Ogólne ustawienia
  7. Webhooks

Webhooks

Webhooki to mechanizm pozwalający na komunikację pomiędzy różnymi systemami (pomiędzy serwerami).

Pozwala na wysyłanie informacji pod ustalony przez administratora adres wywołania (URL) bezpośrednio po wykonaniu zdefiniowanych wcześniej akcji.

Dzięki temu można skonfigurować powiadomienie o wystąpieniu istotnych zdarzeń typu: dodanie zamówienia, aktualizacja zamówienia, usunięcie zamówienia itp.

Informacje te są automatycznie wysyłane do innego systemu w chwili kiedy wystąpi określone zdarzenie.

Użytkownik systemu OptiMES z odpowiednimi uprawnieniami możne skonfigurować takie powiadomienia w Ustawienia → Studio→ Webhooki:

W prawym górnym rogu można utworzyć nowy webhook klikając na ikonę +Dodaj.

Rozsyłana wiadomość (json) wygląda następująco:

public class WebhookMessageDto
    {
        public Guid Id { get; } = Guid.NewGuid(); // unikalny identyfikator tej wiadomości

        public DateTime CreatedAt { get; } = DateTime.Now; // data wygenerowania tej wiadomości

        public string Token { get; set; } // token podany podczas definiowania webhooka

        public string EventSource { get; set; } // źródło zdarzenia które wyzwoliło tego webhooka np. "order.updated" albo "order.created" itp.

        public long WebhookRegistrationId { get; set; } // identyfikator definicji webhooka

        public List<long> Ids { get; set; } = new List<long>(); // lista identyfikatorów w których zaistniało dane zdarzenie (zazwyczaj jeden element)
    }
Czy ten artykuł był pomocny? Tak Nie

Napisz do nas.