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 (wird auch beim Löschen gefeuert)

  7. client_property_created

  8. client_property_updated

  9. client_property_deleted

  10. project_created

  11. project_updated

  12. document_created

  13. document_updated

  14. document_deleted

post
Hook erstellen

https://crm.propstack.de/api/v1/hooks
Request
Response
Request
Query Parameters
target_url
required
string
Die URL, die aufgerufen soll, wenn der Hook ausgelöst wird
event
required
string
Das Ereignis, worauf man hören möchte. Siehe oben für mögliche Werte
Response
200: OK
ID des erstellten Hooks
{
"id": 123
}

get
Hooks aufrufen

https://crm.propstack.de/api/v1/hooks
Request
Response
Request
Response
200: OK
{
"hooks": [
{
"id": 10,
"event": "CLIENT_CREATED",
"target_url": "https://propstack-immobilien.de/ps-hook"
}
]
}

delete
Hook löschen

https://crm.propstack.de/api/v1/hooks/:id
Request
Response
Request
Response
200: OK
{
"ok": true
}