engagementFeedback API

The publisher can use the engagementFeedback API to send feedback in response to the engagement webhook.

Design Recommendation

The engagementFeedback API endpoint should be called from the publisher's backend, and not from the customer application. Exposing this endpoint through the application will result in security concerns related to the API key.

API Request Authorization: Zendrive will provide an authorization key to the publisher to be used with all IQL APIs.

POST https://iql.zendrive.com/iql/v1/engagement_feedback

Headers

Name	Type	Description
Authorization*	String	APIKEY <apikey>

Request Body

Name	Type	Description
request_id*	String	The request_id of the engagement webhook.
data.is_communication_sent_to_user*	Boolean	Whether communication was sent to the user or not.
data.communication_channel		The channel through which communication was sent. Valid values: [sms, email, app_notification, other]. This is a case-insensitive field. This field is mandatory if data.is_communication_sent_to_user is set to true.
data.communication_sent_timestamp	Big Integer	This field contains an epoch timestamp, which represents the time the communication was sent to the user. This field is mandatory, ifdata.is_communication_sent_to_user is set to true.
Success	Boolean	This field represents the overall response status. Expected values: true represents a successful response. false represents a failed request.
error	String	Error description.

200: OK Request created.

{
    // Response
}

400: Bad Request Could be because of an invalid request payload.

{
    // Response
}

401: Unauthorized Check if the API key is provided correctly in the Authorization header.

{
    // Response
}

Sample Request Body

{
    "request_id": "988d7058-fff7-470a-9b0f-63b1cb1e7556",
    "data": {
        "is_communication_sent_to_user": true,
        "communication_channel": "sms",
        "timestamp": 1674557537000
}

Sample Success Response

{
    "success": "true"
}

Sample Error Response

{
    "success": "false",
    "error": "communication_channel is not valid"
}