Webhook Notification

The Shaype platform sends notifications to the client via webhook endpoints. To fully leverage Shaype's features, it is mandatory for the client to implement a solution to receive, handle, and respond to these webhook notifications.

Shaype Platform Obligations

• Ensure the delivery of notifications to the client's designated environment.
• Handle retries of notifications in case of failed delivery or error responses.

Client Obligations

• Provide notification details such as connectivity, authentication, and notification endpoint details to the Shaype Client Integration Team.
• Implement the notification endpoint based on the Swagger documentation provided by Shaype.
• Handle the notifications, take appropriate actions, and respond to the notifications.

Types of Notification

The Shaype platform sends notifications for various operations performed by the client, as well as reminder notifications. Please refer to the type field value in the notification request to determine the notification. The notification can belong to one of the following categories:

• Informative: e.g ACCOUNT_STATUS_CHANGE, CUSTOMER_DETAILS_CHANGE
• Actionable: e.g TRANSACTION
• Reminder: e.g Apple and Goole reminder notification. Please refer Apple and Google Pay Notification doc

Platform Retry Mechanism

• The Shaype platform is responsible for retrying the delivery of notifications if the client service is unreachable, unavailable, or returns a failure response code.
• The platform follow an exponential backoff technique, where operations are retried with progressively increasing wait times, for a specified number of retry attempts.

📘

Points to Note

• The platform will retry sending the webhook notification 18 times over a period of up to 48 hours.
• The platform will retry when it receives any of the following HTTP status codes from the client’s system: 401, 403, 429, 5XX

Notification Endpoints

Shaype has exposed three endpoints for notifications:

• /email: When using the Shaype Accelerator app.
• /sms: When using the Shaype Accelerator app.
• /notification: When using the Shaype B2B APIs.

You can find more details about each webhook sent in a given scenario in it’s relevant Guide section. Eg: Customer and Account webhook events

📘

Points to Note

• Please implement all three endpoints on your end and return a simple 200 success response from the /email and /sms endpoints.
• Ensure that the endpoints are implemented with the same URL paths (/{your-baseURL}/api/hay/v0/communications/{notifcation-type} where notification type is [“/notification”, “/email“, “/sms]) provided by Shaype.