Configuring Allowlist URL/SQS to receive Delivery Report

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 a location of your convenience, 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.

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

Callback Objects in a Request

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

Callback Response

The following contains list of default fields which will be sent if the payload for the delivery status callback is not defined.

The Delivery Webhook will be sent using:

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

Default Parameters

Additional Parameters

Additional Parameters can be sent in the response by configuring the same in your “Delivery Webhook” URL. All you will need to do is configure it as a Placeholder as shown in the sample payload below.

This configuration needs to be done in the payload section when converting an Allowlist URL to a Delivery Webhook

Here is a sample payload for reference.

1
{
2
     "param1": "{{destination}}",
3
     "param2": "{{provider}}",
4
     "param6": "{{integration_name}}",
5
      …………
6
}

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.

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
}