How to receive Delivery Reports

To receive delivery reports in your system, you need to follow the below steps

1. Add an Allowlist URL/SQS and get it verified.
2. Configure the delivery data points you want to receive
3. Configure the Allowlist URL/SQS to receive delivery report
   • Through API
   • Through Campaign
   • Through Workflow

1. Add an Allowlist URL and get it verified

Allowlist (also commonly called as Webhooks) is a list of URLs or SQS that you would need to add to the Fyno platform and verify before you use it on the application and in your workflows.

You need to add Allowlist URL or SQS in 2 cases.

• When you want to receive a delivery report from Fyno to your system
• When you want to call your API from Fyno’s Workflow

The need for an Allowlist

Allowlists were designed for Fyno’s app users to ensure security for the information that is being plugged into the system, by having verified URLs/SQS and thus help avoid unnecessary security hassles.

Types of Allowlist

You can add Allowlists as:

1. URL
2. SQS

2. Configure the delivery data points you want to receive

A Delivery Webhook is nothing but an Allowlist URL that can receive updates from Fyno regarding the delivery status of the notifications sent out and easily share the delivery details with you, to any verified endpoint, pre-decided by you.

An Allowlist URL can be converted anytime to a Delivery Webhook, once it is successfully verified by following the below steps while adding Allowlist URL/SQS.

The first Delivery Endpoint you create will be considered as ‘Default’ and you will start receiving your delivery reports in that URL. At any point of time, there will be only one default Allowlist URL. If you want to receive delivery reports in other URLs other than default URLs, you need to specify it in the payload as explained in the next section.

1Select the ‘Configure as Delivery Endpoint’ by clicking the ellipsis as shown.

2In the window that opens, you can select the checkbox ‘Set as default endpoint to receive delivery endpoints’

3Select the Method as ‘POST’

4Optionally you can add any Header params

5Choose Content Type from one of the options : application/json | multipart/form-data | application/x-www-form-urlencoded

6You can add the data points you want to receive in the Payload section and click ‘Confirm’.

If you didn’t any parameters in the payload, Fyno will send the below default parameters.

Default Parameters

Below is a list of all the parameters that Fyno can send you as data points. However, each one of these will need to be specified if you need them.

Once this is done, all the delivery statuses for every notification triggered will be automatically updated at this location.

3. Configure the Allowlist URL to receive delivery report

You can configure delivery callback when you are triggering through

• API
• Campaign
• Workflow

How to configure delivery callback through API

When you are triggering a notification event using API, you need to pass additional parameters in the payload

Sample Notification Event API with delivery callback details

1
{
2
   "event": "YOUR_EVENT_NAME",
3
   "to": { // you channel destination },
4
   "data": {  // your template placeholders  },
5
   "callback": {
6
       "custom_id": "YOUR_CUSTOM_ID_VALUE",
7
       "custom1":"3d066514-c55d-48f8-b7ff",
8
       "custom2":"3d066514-c55d-48f8-b7ff-3981a43c20d4",
9
       "allowlist_url": ["DynamicWebhookSite", "Mixpanel"],
10
       "enable":true
11
    }
12
}

How to configure delivery callback in Campaign

To enable receiving delivery reports from Fyno, select the checkbox ‘Receive delivery report from Fyno to my allowlisted endpoint(s)’. This enables the callbacks for the channels and essentially sends back the delivery updates about each notification triggered. On checking this box, 3 additional placeholder details will need to be configured.

More values can be added in the callback. For a list of additional available values, please see: Callback Response

How to configure delivery callback in Workflow

1To configure callbacks to receive delivery reports, click the Settings icon while configuring notification event within a workflow as shown below.

2It opens the page as shown below. Select the ‘Do you want to receive a delivery report?’ checkbox.

3

This option allows you to receive Delivery reports of each notification triggered in any URL you have allowlisted in Fyno. It can be done in 2 ways.

1. From Allowlist - Selecting Delivery Report Endpoint(s) from Verified Allowlist URLs (Maximum 3 can be selected).
2. Custom - Selecting Delivery Report Endpoint from payload or a simplified custom variable. (Only 1 can be selected).

Once the Delivery Endpoint URL(s) is selected, 3 additional placeholder details need to be configured.

More values can be added in the callback. For a list of additional available values, click here.

Callback Response

The Delivery Webhook will be sent using:

• Method: POST | GET
• Content-Type : application/x-www-form-urlencoded | application/json
• Data: Default Parameters + Additional Parameters

Sample Webhook Configuration and Response

Sample configuration for the additional parameters (JSON) in Webhooks Delivery status section

1
{
2
  "url": "https://webhook.site/847c54cc-c471-40f4-b793-36c18a",
3
  "method": "post",
4
  "headers": {
5
    "Content-Type": "application/json"
6
  },
7
  "data": {
8
    "recipent": "{{destination}}",
9
    "providername": "{{provider}}",
10
    "provider_msg_id": "{{provider_msg_id}}",
11
    "provider_template_id": "{{provider_template_id}}",
12
    "message": "{{message}}",
13
    "request_time": "{{senttime}}",
14
    "delivery_time": "{{dlrtime}}",
15
    "account_name": "{{integration_name}}",
16
    "reference_msg_id": "{{custom_id}}",
17
    "order_id": "{{custom1}}",
18
    "category": "{{custom2}}",
19
    "channel": "{{channel}}"
20
  }
21
}

Once this is successfully configured, here is a sample of the Callback Response you would receive.

1
{
2
  "msg_id": "FYNO_MSG_ID_UUID",
3
  "status": "DELIVERED",
4
  "custom_id": "YOUR_CUSTOM_ID_VALUE",
5
  "recipent": "user1@email.com",
6
  "providername": "sendgrid",
7
  "provider_msg_id": "1234567890",
8
  "provider_template_id": "",
9
  "message": "",
10
  "requesttime": "2023-03-24 10:23:39",
11
  "deliverytime": "2023-03-24 10:23:50",
12
  "account_name": "EmailProduction",
13
  "reference_msg_id": "YOUR_CUSTOM_ID_VALUE",
14
  "order_id": "YOUR_CUSTOM1_VALUE",
15
  "category": "YOUR_CUSTOM2_VALUE",
16
  "channel": "email"
17
}