Webhooks

Mit Webhooks kann man über bestimmte Ereignisse in Propstack benachrichtigt werden, wie z.B. wenn ein Objekt aktualisiert wird.

Wenn ein Event ausgelöst wird, wird die URL unter target_url mit einem POST aufgerufen und die Daten des Kontaktes bzw. des Objektes mit übergeben.

Bei client_updated und property_updated wird zusätzlich der Parameter changed_attributes übergeben, damit man auf Aktualisierungen von bestimmten Feldern reagieren kann. Beispielsweise will man in seiner eigenen App eine Aktion ausführen, sobald sich der Preis eines Objektes ändert, und nicht bei jedem Update eines Objektes.

Mögliche Events:

  1. client_created

  2. client_updated (wird auch beim Löschen gefeuert)

  3. property_created

  4. property_updated (wird auch beim Löschen gefeuert)

  5. task_created

  6. task_updated

  7. task_deleted

  8. client_property_created

  9. client_property_updated

  10. client_property_deleted

  11. project_created

  12. project_updated

  13. document_created

  14. document_updated

  15. document_deleted

  16. saved_query_created

  17. saved_query_updated

  18. saved_query_deleted

Hook erstellen

POST https://api.propstack.de/v1/hooks

Query Parameters

NameTypeDescription

target_url

string

Die URL, die aufgerufen soll, wenn der Hook ausgelöst wird

event

string

Das Ereignis, worauf man hören möchte. Siehe oben für mögliche Werte

{
    "id": 123
}

Hooks aufrufen

GET https://api.propstack.de/v1/hooks

{
    "hooks": [
        {
            "id": 10,
            "event": "CLIENT_CREATED",
            "target_url": "https://propstack-immobilien.de/ps-hook"
        }
    ]
}

Hook löschen

DELETE https://api.propstack.de/v1/hooks/:id

{
    "ok": true
}

Last updated