Webhooks

Rekaz Webhooks Integration Guide 🚀

In Rekaz We offer integration to any 3rd party system, Webhooks allow real-time notifications when events occur in Rekaz. Configure your endpoint to receive JSON payloads for instant updates about reservations and subscriptions.

How Rekaz Webhook Integation system works 🤔

diagram below will illustrate how Rekaz handle Webhooks

Supported Event Types 🔔

Reservation Events

Event Name	Trigger Condition
ReservationCreatedEvent	New reservation created
ReservationConfirmedEvent	Reservation confirmed by system
ReservationDoneEvent	Reservation successfully completed
ReservationCancelledEvent	Reservation cancelled by user or admin

Subscription Events

Event Name	Trigger Condition
SubscriptionCreatedEvent	New subscription created
SubscriptionActivatedEvent	Subscription becomes active
SubscriptionCancelledEvent	Subscription cancelled
SubscriptionExpiredEvent	Subscription reaches expiration date
SubscriptionPausedEvent	Subscription paused
SubscriptionResumedEvent	Paused subscription resumes

Payload Specifications 📦

Reservation Payload

Properties

Property	Type	Required	Description	Example
id	Guid	Required	Unique identifier for the reservation	5f47ac7b-8d8b-4e20-b84c-5eaf142e4f3d
startDate	DateTime	Required	Start time of the reservation	2025-02-10T10:00:00
endDate	DateTime	Required	End time of the reservation	2025-02-15T15:00:00
status	ReservationStatus	Required	Current reservation status	Confirmed, Cancelled, Pending, Done
customStatus	string	Optional	Optional custom status	Gifted
price	decimal	Required	Total reservation price	250.00
discount	decimal	Required	Applied discount amount	25.00
customer	object	Optional	Customer details (name, phone)	See example below
productName	string	Optional	Associated product name	Hotel Suite
priceName	string	Optional	Pricing category name	Early Bird Special
number	string	Optional	Reference number	RES123456
cancellationReason	string	Optional	Reason for cancellation	Schedule conflict

Sample Reservation Payload

{
  "id": "5f47ac7b-8d8b-4e20-b84c-5eaf142e4f3d",
  "startDate": "2025-02-10T10:00:00",
  "endDate": "2025-02-15T15:00:00",
  "status": "Confirmed",
  "customStatus": "Gifted",
  "price": 250.00,
  "discount": 25.00,
  "customer": {
    "name": "John Doe",
    "phone": "966501111111"
  },
  "productName": "Hotel Suite",
  "priceName": "Early Bird Special",
  "number": "RES123456",
  "cancellationReason": "Schedule conflict"
}

Subscription Payload

Properties

Property	Type	Required	Description	Example
id	Guid	Required	Unique identifier for the subscription	9b1ac7b-3d8b-5f20-c84c-6eaf142e4f9a
startDate	DateTime	Required	Subscription start time	2025-03-01T09:00:00
endDate	DateTime	Required	Subscription end time	2025-03-31T23:59:59
status	SubscriptionStatus	Required	Current subscription status	Pending, Active, Cancelled, Suspended, Expired, Paused, Transferred, StartingSoon
customStatus	string	Optional	Optional custom status	Gifted
price	decimal	Required	Total subscription price	150.00
discount	decimal	Required	Applied discount amount	15.00
customer	object	Optional	Customer details (name, phone)	See example below
name	string	Optional	Subscription name	Premium Monthly Plan
number	string	Optional	Reference number	SUB789012
code	string	Optional	Unique subscription code	PRM-2025

Sample Subscription Payload

{
  "id": "9b1ac7b-3d8b-5f20-c84c-6eaf142e4f9a",
  "startDate": "2025-03-01T09:00:00",
  "endDate": "2025-03-31T23:59:59",
  "status": "Active",
  "customStatus": "Gifted",
  "price": 150.00,
  "discount": 15.00,
  "customer": {
    "name": "Jane Smith",
    "phone": "966502222222"
  },
  "name": "Premium Monthly Plan",
  "number": "SUB789012",
  "code": "PRM-2025"
}

Implementation Guide ⚙️

• Set Your Endpoint : POST https://your-api.com/rekaz-webhooks

• Go to platform.rekaz.io/Identity/apikeys

• In webhooks section add your webhook url

Additional information ✅

Retry Policy ↻

• Failed webhooks are automatically retried up to 10 times

• Exponential backoff delay between retries

• Initial retry interval is short and increases with each attempt

Success Criteria

• Webhook is considered successful when the response status code is in the 2xx range

• Ensure your endpoint returns appropriate HTTP status codes