Hoppa till huvudinnehåll

Webhooks

Denna artikel beskriver vilka webhooks som finns tillgängliga i Funbutler och hur de fungerar.

Uppdaterad för mer än 2 veckor sedan

Setup

En webhook registreras med en specifik URL för en specifik händelse (Event) kopplad till en specifik entitet (Entity).

Följande entiteter och händelser stöds:

Entitet: BOOKING

  • CREATED

  • CHECKED_IN

  • CANCELED

Entitet: EVENT_BOOKING

  • CREATED

  • CANCELED

Payload

När en webhook triggas skickas en POST-förfrågan till den registrerade URL:en med en JSON-payload.

Varje anrop innehåller följande JSON-objekt. Innehållet i fältet data är beroende av händelsen.

{   "clientId": "<CLIENT ID>",   "entity": "<ENTITY NAME>",   "event": "<EVENT NAME>",   "data": { <EVENT SPECIFIC PAYLOAD> } }


Entitet: BOOKING

CREATED

Triggas när en bokning skapas.

Exempel:

{   "clientId": "5c7bc6f6161f0b2e10555060",   "entity": "BOOKING",   "event": "CREATED",   "data": <Booking> }

Se API-dokumentationen för detaljer om objektet <Booking>.


CHECKED_IN

Triggas när en bokning checkas in.

Exempel:

{   "clientId": "5c7bc6f6161f0b2e10555060",   "entity": "BOOKING",   "event": "CHECKED_IN",   "data": <Booking> }

Se API-dokumentationen för detaljer om objektet <Booking>.


CANCELED

Triggas när en bokning avbokas.

Exempel:

{   "clientId": "5c7bc6f6161f0b2e10555060",   "entity": "BOOKING",   "event": "CANCELED",   "data": <Booking> }

Se API-dokumentationen för detaljer om objektet <Booking>.


Entitet: EVENT_BOOKING

CREATED

Triggas när en eventbokning skapas.

Exempel:

{   "clientId": "5c7bc6f6161f0b2e10555060",   "entity": "EVENT_BOOKING",   "event": "CREATED",   "data": <Event Booking> }

Se API-dokumentationen för detaljer om objektet <Event Booking>.


CANCELED

Triggas när en eventbokning avbokas.

Exempel:

{   "clientId": "5c7bc6f6161f0b2e10555060",   "entity": "EVENT_BOOKING",   "event": "CANCELED",   "data": <Event Booking> }

Se API-dokumentationen för detaljer om objektet <Event Booking>.

Fick du svar på din fråga?