Comment on page
Notification
The Notification API allows you to send notifications to users, including generic messages and WhatsApp messages. This API provides endpoints for sending different types of notifications.
This endpoint allows you to send a generic notification to users by their IDs. You can customize the notification content using the request body.
Endpoint Details:
- HTTP Method: POST
- Security: Bearer Token Authentication
- Description: Send a generic notification to users.
- Consumes: application/json
- Produces: application/json
- Tags: Notification
- Summary: Send a generic notification to users.
Request Parameters:
X-Neucron-App-ID(Header) - The ID of the Neucron application.X-Neucron-Key-ID(Header) - The ID of the Neucron key.X-Neucron-Key-Secret(Header) - The secret key for authentication.X-Neucron-User-ID(Header) - The user ID to send the notification to.subs(Body) - The notification body. Please refer to the schemanotifmodel.UserNotifReqfor the expected structure.
Response:
200 OK- The notification was sent successfully.400 Bad Request- Invalid request or missing parameters.401 Unauthorized- Authentication failed.409 Conflict- Conflict or error in processing the request.500 Internal Server Error- An internal server error occurred.
Oops, something is missing.We could not find the original source to display this content.
This endpoint allows you to send a WhatsApp message to users by their IDs. You can customize the WhatsApp message content using the request body.
Endpoint Details:
- HTTP Method: POST
- Security: Bearer Token Authentication
- Description: Send a WhatsApp message to users.
- Consumes: application/json
- Produces: application/json
- Tags: Notification
- Summary: Send a WhatsApp message to users.
Request Parameters:
X-Neucron-App-ID(Header) - The ID of the Neucron application.X-Neucron-Key-ID(Header) - The ID of the Neucron key.X-Neucron-Key-Secret(Header) - The secret key for authentication.subs(Body) - The WhatsApp message body. Please refer to the schemanotifmodel.WhatsAppMessagefor the expected structure.
Response:
200 OK- The WhatsApp message was sent successfully.400 Bad Request- Invalid request or missing parameters.401 Unauthorized- Authentication failed.409 Conflict- Conflict or error in processing the request.500 Internal Server Error- An internal server error occurred.
Oops, something is missing.We could not find the original source to display this content.
This endpoint allows you to send a WhatsApp message with a template to users by their IDs. You can customize the WhatsApp message content using the request body.
Endpoint Details:
- HTTP Method: POST
- Security: Bearer Token Authentication
- Description: Send a WhatsApp message with a template to users.
- Consumes: application/json
- Produces: application/json
- Tags: Notification
- Summary: Send a WhatsApp message with a template to users.
Request Parameters:
X-Neucron-App-ID(Header) - The ID of the Neucron application.X-Neucron-Key-ID(Header) - The ID of the Neucron key.X-Neucron-Key-Secret(Header) - The secret key for authentication.subs(Body) - The WhatsApp message body. Please refer to the schemanotifmodel.WhatsAppMessagefor the expected structure.
Response:
200 OK- The WhatsApp message with a template was sent successfully.400 Bad Request- Invalid request or missing parameters.401 Unauthorized- Authentication failed.409 Conflict- Conflict or error in processing the request.500 Internal Server Error- An internal server error occurred.
Oops, something is missing.We could not find the original source to display this content.
Please ensure that you provide the required headers and valid request bodies when using these endpoints to send notifications. In case of any issues, the API will return appropriate error responses for further troubleshooting. If you have any questions or need more information about specific schemas, please refer to the corresponding documentation or contact the API support team.
Last modified 3mo ago