If you would wish to setup custom notifications as a campaign option, here is how you can do it.
Settings/Custom Notifications
The request triggered to your URL will contain an X-DPDZERO-TOKEN header for you to be able to verify this.
{
"customer_name": "Ranjith",
"amount_pending": "1.00",
"loan_number": "xxxxx",
"status": "PENDING",
"remarks": null,
"mobile_number": "xxxxxx",
"due_date": "2022-04-07",
"email": null,
"customer_state": null,
"text_column_1": "VAL1",
"text_column_2": null,
"text_column_3": null,
"text_column_4": null,
"text_column_5": null,
"text_column_6": null,
"text_column_7": "g",
"text_column_8": null,
"text_column_9": null,
"text_column_10": null,
"numeric_column_1": "-2.00",
"numeric_column_2": null,
"numeric_column_3": null,
"date_column_1": null,
"date_column_2": null,
"date_column_3": null,
"tags": [],
"id": "140",
"dpd": 7,
"payment_short_id": "7LGJBe",
"payment_link": "https://app.dpdzero.com/p/7LGJBe",
"payment_short_link": "https://fnmo.in/l/7LGJBe",
"compiled_text": "Hi Ranjith, your loan number is 10001. Please make a payment. Click here to make payment of INR 1.00: https://fnmo.in/l/7LGJBe",
"callback_url": "https://app.dpdzero.com/api/v1/webhooks/custom-notifications/7LGJBe"
}The templates allow you to trigger a compiled text message and this can be used as is. If no template is configured, compiled_text will be empty.
Expected response is a 200 Okay Message from your end.
Please note that callback_url is present in the notification request sent to you.
Once you have delivered the notification to the customer, you can send back callbacks to DPDzero in the following format,
{
"payment_short_id": "axuyadanb",
"message_status": "DELIVERED",
"promise_to_pay": "2022-01-22T02:00:00+05:30",
"send_follow_up": true,
"follow_up_request": {
"channel": "SMS",
"template_id": "template_id"
}
}The following statuses are permitted
| Status | Meaning |
|---|---|
| DELIVERED | Message has been read by the customer |
| READ | Customer has read the message |
| FAILED | Failed to capture delivery |
Using this mechanism, DPDzero populates the analytics for the campaign and displays the effectiveness of the campaign on the dashboard.