Webhooks

Webhook Payload

This is an example of the payload you'll receive when we make a webhook request to your server. Anything other than a 2xx response will be treated as a failure and redirects will not be followed.

This entry documents the payload we send to you. It is not a callable Timetastic endpoint.

post/api/webhooks

Request

  • Base URL: https://app.timetastic.co.uk (the document declares no server; this is the origin it was published from)
  • URL: https://app.timetastic.co.uk/api/webhooks
  • Auth: none declared

Response

The shape of the payload we POST to your webhook URL. Shown for reference only; this endpoint never returns it.

eventIdinteger

Event ID is how we reference individual events. They are globally unique per event

eventType'TestEvent' | 'AbsenceRequested' | 'AbsenceApproved' | 'AbsenceDeclined' | 'AbsenceCancelled' | 'AbsenceBooked' | 'AbsenceUpdated'

The type of event we're raising - The recordID will be related to this

  • TestEvent
  • AbsenceRequested
  • AbsenceApproved
  • AbsenceDeclined
  • AbsenceCancelled
  • AbsenceBooked
  • AbsenceUpdated
urlstring nullable

The URL We're posting to

recordIdinteger

The related record the event concerns. This is currently just the HolidayID as Webhooks only reference bookings for now.

timestampstring date-time

When did the event happen (UTC)

Changes

No recorded changes to this operation across all 1 revision of this API.