LogoLogo
  • Introduction
  • Authentication
  • Endpoints
    • Content
    • Quote
    • Status
    • Update
    • Purchase
    • Cancel
    • InstantBooking
    • Update Customer
    • Notifications/list
    • Notification/update
    • GetAllPurchasedPolicies
    • GetAllCancelledPolicies
    • CoverOptOut
    • Invoice
  • Webhook
    • HMAC Verification
    • Events
      • Cancellation Event
  • Testing
  • Errors
    • Quote Errors
    • Purchase Errors
    • Cancel Errors
  • Supported Currencies
  • Supported Languages
  • Supported Regions
  • Non-API Functions
Powered by GitBook
On this page
  • Step 1: Expose an endpoint on your server
  • Step 2: Set up webhooks and events
  • Step 3: Accept webhooks

Webhook

PreviousInvoiceNextHMAC Verification

Last updated 9 months ago

Rental Cover provides webhooks that partners can register and listen to, in order to receive automatic updates regarding bookings. For example, information about booking cancellations.

To manage webhooks, you can inform your Client Solution Engineer (CSE) from Rentalcover and configure webhook events.

To process webhooks, you need to:


Step 1: Expose an endpoint on your server

Webhooks are HTTP callbacks sent to an endpoint on your server.

To receive webhook events, you need a server that has the following:

  • An endpoint that can receive an HTTP POST request.

Step 2: Set up webhooks and events

In the RC backend, the admin can configure the endpoint that maps to the webhook event.

Available Events: booking.cancelled, booking.created, booking.updated.

Step 3: Accept webhooks

When we deliver a webhook event to your server:


Verify the HMAC signature included in the request header This confirms that the webhook event was sent by Rentalcover and remained unaltered during transmission. For more details, refer to . If the HMAC signature is invalid, we do not recommend acknowledging the webhook event.

Acknowledge the webhook event with a , Eg. 200 for successful. In an instance of error, we recommend responding with an appropriate .

Authentication
successful HTTP response status code
error HTTP response status code
Expose an endpoint on your server.
Set up webhooks in the RC backend
Accept webhook events.