It enables you to send responses, escalations etc. to an HTTP endpoint automatically every hour. The HTTP endpoint is owned by you and it gives you a way to receive data from Zykrr platform and thereby complete freedom and control to integrate with any system on your side.

HTTP endpoint requirements:

1. It should be a HTTPS JSON API with TLS 1.2 or above
2. It should be of POST HTTP method.
3. It should accept a JSON in the request body. A sample is provided below.
4. Submitted response(s) will be pushed to the API within 30 mins from response submission time.
5. The API endpoint should send HTTP 200 OK status code as acknowledgement of successful reception. Any status code above 400 will be treated as an error by Zykrr system.
6. The API endpoint should respond within 60 seconds with success otherwise it is treated as failure by the Zykrr system.

If a request failed, those responses are sent along with newer in the next round. Following is a sample request body

• ‘campaignId’ field denotes the campaign id in which the response was submitted.
• ‘responses’ contains one or more submitted responses in the campaign.
• ‘responses[].id’ is the zykrr system id for this response.
• ‘responses[].answers’ contain all the questions and their answers submitted in the response as key-value pairs. If the respondent did not answer a question then it’s key won’t be present in it.
• ‘responses[].participantInfo’ contains information of the participant who submitted the response.
• ‘responses[].createdAt’ contains the date-time in ISO format at which the response was submitted.

Below in an example of request body

{
  "campaignId": "808f8bae-c567-4786-87d3-b0421469c025",
  "responses": [
    {
      "id": "9e5a8c59-0436-4fa1-b88a-8f44f8a2b9d7",
      "answers": {
        "ee52f7d1-96be-4437-beb4-6667f8e36413": 0,
        "420adde8-2c72-4e20-93fd-068f473d78b3": 0,
        "c2406479-7ce2-4e1c-a0b0-384b8e8be4b9": 2,
        "c3c77e03-9518-4c4f-8970-c816592d0e6b": 6,
        "b0055957-385a-491f-aaec-3ef8239e3d2d": 9,
        "a724f23e-8c55-4803-a88c-b0a1bacda735": 6,
        "90fad279-11b9-43c2-b115-3c9664c48faa": "Lorem, ipsum dolor sit amet consectetur adipisicing elit.",
        "5c354c2e-d3db-4669-8a5c-1039ac2e89f9": "yes",
        "6dc1f15c-e577-4fa1-b271-c52418a2c4fe": "30 mins - 1.5 hrs",
        "cad3a36b-16c5-4ed3-8cfe-3037247f34f7": "director",
        "b43e9b01-37be-49b2-bb8d-1149ccd80aed": "Lorem, ipsum dolor sit amet consectetur adipisicing elit."
      },
      "participantInfo": {
        "Name": "Diwakar",
        "Email": "diwakar_singh_maurya@zykrr.com",
        "Phone": "918800174323"
      },
      "createdAt": "2022-03-02T16:41:23.833Z"
    }
  ]
}