Toolverse
All skills

maintainx-webhooks-events

by jeremylongshore

Implement MaintainX webhook handling and event-driven integrations.\nUse when setting up webhooks, handling MaintainX events,\nor building real-time integrations with MaintainX.\nTrigger with phrases like \

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Category
Security
Views
1

About this skill

Implement MaintainX webhook handling and event-driven integrations.\nUse when setting up webhooks, handling MaintainX events,\nor building real-time integrations with MaintainX.\nTrigger with phrases like \

How to use

  1. Przygotuj środowisko: upewnij się, że masz skonfigurowaną zmienną MAINTAINX_API_KEY z kluczem API z konta MaintainX. Jeśli pracujesz lokalnie, użyj narzędzia takiego jak ngrok, aby udostępnić swój serwer w internecie.

  2. Zarejestruj webhook w MaintainX, wysyłając żądanie POST do https://api.getmaintainx.com/v1/webhooks z nagłówkiem autoryzacji i listą zdarzeń, które chcesz monitorować (np. workorder.created, workorder.updated, workorder.status_changed, workorder.completed). Podaj publiczny adres URL swojego serwera jako punkt docelowy.

  3. Skonfiguruj serwer odbierający (np. Express.js), aby nasłuchiwał żądań POST na ścieżce /webhooks/maintainx. Implementuj middleware weryfikujący podpis z nagłówka x-maintainx-signature, aby upewnić się, że żądania pochodzą od MaintainX.

  4. Przetwarzaj zdarzenia w funkcji obsługi webhook: odczytaj typ zdarzenia i dane z treści żądania, a następnie wykonaj odpowiednie akcje (np. zaktualizuj bazę danych, wyzwól powiadomienia, zsynchronizuj z innymi systemami).

  5. Zwróć odpowiedź HTTP 200 OK, aby potwierdzić, że webhook został pomyślnie przetworzony. MaintainX będzie ponownie próbować dostarczenia, jeśli nie otrzyma potwierdzenia.

Related skills