Ctrl + K
Msg91 Help Doc
Webhook (New)
How to Receive Push Notificati...

How to Receive Push Notifications Reports via Webhook

You can use the Webhook feature on the MSG91 platform to receive delivery reports of the Push Notifications. Follow the steps below to set it up.

1. Log in to your MSG91 Dashboard » Push Notifications » Webhook » Click on Create Webhook

Mystic2-MSG91-08-02-2025_07_00_PM.png

2. Configure Your Webhook

image

Step 1: Provide a name to your webhook

Step 2: Select the service - Push Notifications and the event type.

On Request Received: Triggers when a request is sent from your account.

On Report Received: Triggers to send real-time delivery reports of your push notifications. It includes the delivery status.

Step 3: Enter your Webhook URL (Callback URL) where data should be sent.

  • When you send requests, the webhook will still send one log per contact_id. This means for each contact_id, you will receive a separate webhook event, even if all requests are sent in a single batch.

  • The value of a few parameters is a stringified JSON array, so make sure your Webhook is capable of receiving such data.

Content-Type: Only JSON is supported. Ensure your endpoint can parse JSON data in any format.

Step 4. Customize Data Parameters.

Use { to add fields/ parameters you want to receive.

You can include or exclude fields as needed. Ensure parameters follow valid JSON formatting.

Example JSON payload that has all the available parameters:

{

  "CRQID": "{{CRQID}}",

  "uuid": "{{uuid}}",

  "contactId": "{{contactId}}",

  "companyId": "{{companyId}}",

  "status": "{{status}}",

  "templateName": "{{templateName}}",

  "content": "{{content}}",

  "campaignName": "{{campaignName}}",

  "nodeId": "{{nodeId}}",

  "statusUpdatedAt": "{{statusUpdatedAt}}"

}


Description of the parameters:

  • CRQID
    A custom parameter you can pass in the API body. You will receive the same value in the webhook.
    Example: "CRQID": "MSG91_PushNotification"

  • uuid
    Unique reference ID for every request.
    Example: "uuid": "8ee1c0bcd7664939a3c92359b3328272"

  • contactId
    Contact ID of the contact in Segmento to which you sent the push notification.
    Example: "contactId": "manas744jjgu"

  • companyId
    Unique ID of your MSG91 account.
    Example: "companyId": "454228"

  • status
    Status of your push notification.
    Example: "status": "delivered"

  • templateName
    The name of your Push Notifications Template..
    Example: "templateName": "augustoffer"

  • content
    HTML content of the template that you sent.
    Example: "content": "<!DOCTYPE html>\n<html lang=\"en\">\n<head style=\"margin: 0\">\n  <meta charset=\"UTF-8\">\n  <title style=\"margin: 0\">Inspirational Popup</title>\n  <style style=\"margin: 0\">\n    body {\n      margin: 0;\n      font-family: Arial, sans-serif;\n    }\n\n    .topbar {\n      background-color: #ffcc00;\n      color: #000;\n      text-align: center;\n      padding: 15px;\n      font-weight: bold;\n      position: fixed;\n      top: 0;\n      width: 100%;\n      z-index: 9999;\n      box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);\n    }\n\n    .content {\n      padding-top: 70px;\n      text-align: center;\n    }\n\n    .popup {\n      position: fixed;\n      top: 50%;\n      left: 50%;\n      width: 10cm;\n      height: 10cm;\n      transform: translate(-50%, -50%);\n      background-color: #ffffff;\n      border: 2px solid #333;\n      box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);\n      display: flex;\n      align-items: center;\n      justify-content: center;\n      padding: 20px;\n      font-size: 1.2em;\n      font-style: italic;\n      z-index: 10000;\n    }\n  </style>\n</head>\n<body style=\"margin: 0\">\n\n  <div class=\"topbar\">\n    Important Notice: This is a topbar alert message!\n  </div>\n\n  <div class=\"content\">\n    <h1 style=\"margin: 0\">Welcome</h1>\n    <p style=\"margin: 0\">This is the main content.</p>\n  </div>\n\n  <div class=\"popup\">\n    \"The only way to do great work is to love what you do.\" – Steve Jobs\n  </div>\n\n</body>\n</html>”

  • campaignName
    Name of the campaign through which you sent the request.
    Example: "campaignName": "Julyleads"

  • nodeId
    Node ID of the campaign through which you launched the campaign.
    Example: "nodeId": "89420"

  • statusUpdatedAt
    This indicates the timestamp when the status of your Push Notification was updated.
    Example: "statusUpdatedAt": "2025-08-02T13:00:32.000+00:00"


Sample payload of the data received on Webhook:

{

  "CRQID": "AugustOffer",

  "uuid": "c1a84eee845f4c0dad07d96119b78f54",

  "contactId": "manas",

  "companyId": "454228",

  "status": "delivered",

  "templateName": "augustoffer",

  "content": "<!DOCTYPE html>\n<html lang=\"en\">\n<head style=\"margin: 0\">\n  <meta charset=\"UTF-8\">\n  <title style=\"margin: 0\">Inspirational Popup</title>\n  <style style=\"margin: 0\">\n    body {\n      margin: 0;\n      font-family: Arial, sans-serif;\n    }\n\n    .topbar {\n      background-color: #ffcc00;\n      color: #000;\n      text-align: center;\n      padding: 15px;\n      font-weight: bold;\n      position: fixed;\n      top: 0;\n      width: 100%;\n      z-index: 9999;\n      box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);\n    }\n\n    .content {\n      padding-top: 70px;\n      text-align: center;\n    }\n\n    .popup {\n      position: fixed;\n      top: 50%;\n      left: 50%;\n      width: 10cm;\n      height: 10cm;\n      transform: translate(-50%, -50%);\n      background-color: #ffffff;\n      border: 2px solid #333;\n      box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);\n      display: flex;\n      align-items: center;\n      justify-content: center;\n      padding: 20px;\n      font-size: 1.2em;\n      font-style: italic;\n      z-index: 10000;\n    }\n  </style>\n</head>\n<body style=\"margin: 0\">\n\n  <div class=\"topbar\">\n    Important Notice: This is a topbar alert message!\n  </div>\n\n  <div class=\"content\">\n    <h1 style=\"margin: 0\">Welcome</h1>\n    <p style=\"margin: 0\">This is the main content.</p>\n  </div>\n\n  <div class=\"popup\">\n    \"The only way to do great work is to love what you do.\" – Steve Jobs\n  </div>\n\n</body>\n</html>",

  "campaignName": "motivationpushnotif",

  "nodeId": "89425",

  "statusUpdatedAt": "2025-08-02T13:00:32.000+00:00"

}

You can also add the Headers in the key-value pairs, and we will send all the reports along with these Headers:

image


Final Step - Click Create to save the Webhook.

Still have questions?

Feel free to reach us at +91 8818888733 via call or WhatsApp, or drop an email to [email protected].