Getting Started

This is an introduction to our VisitReport Webhook API. With the VisitReport Webhook API you can export your VisitReport reports to your own software systems. This can be a practical solution for custom or inhouse report data processing. This includes a template and all answers of the selected reports during the webhook export.

Webhook Usage

In this section we take a look at how to use use our VisitReport Webhook API.

First, you have to configure your template. This can be done in the settings of your template, which is shown in the screenshot below. In the field VisitReport Webhook Target URL you can specify where the exported template data should be sent to. In the optional field VisitReport Webhook Authorization Header you can specify a HTTP header that our API will send together with the template data. This might be necessary if your VisitReport Webhook Target URL requires requests to be authenticated. The string value you configure is passed as a Authorization: <value> HTTP header.

Afterwards, you can trigger the VisitReport Webhook in a template report overview. The next screenshot shows how this looks like. You can either export a single record by opening the export context menu and selecting Webhook or export several records by selecting them and choosing Export via Webhook at the bottom.

Structure of Exported Data

The exported data looks like the following. It contains the respective questionnaire (template) and questions. Additionally, it contains all selected participants (reports) and their respective answers to the questions of the questionnaire.

{
  "questionnaire": {
    "id": "a9egORnjNjnpJk46",
    "mappingId": "a9egORnjNjnpJk46",
    "titles": {
      "de": "ISH, Frankfurt 2017",
      "en": "ISH, Frankfurt 2017 (English)"
    },
    "descriptions": {},
    "defaultLanguage": "de",
    "languages": ["de", "en"],
    "organizationId": "dxzyOGP37PaZ658k",
    "createdByUserId": "9zkArmPLane1jK20",
    "color": {
      "Hue": 64,
      "Saturation": 88,
      "Lightness": 33,
      "hue": 64,
      "saturation": 88,
      "lightness": 33
    },
    "url": "",
    "logo": "",
    "participantCounter": 0,
    "finalized": true,
    "archived": false,
    "settings": {}
  },
  "participants": [{
    "id": "v1pZ4JPvNPgXRm0M",
    "created": "2216-10-16T00:00:00.000Z",
    "firstName": "John",
    "lastName": "Doe",
    "organization": "",
    "email": "johndoe@doesnotexist.com",
    "phone": "",
    "bcImage": "assets/bcImage.png",
    "bcImageBackside": "",
    "bcImageLocal": "",
    "bcImageBacksideLocal": "",
    "bcChecked": null,
    "createdByUserId": "9zkArmPLane1jK20",
    "drawing": "",
    "image": "",
    "note": "",
    "gender": null,
    "title": "",
    "position": "",
    "mobile": "",
    "fax": "",
    "website": "",
    "vat": "",
    "street": "",
    "city": "",
    "zip": "",
    "poBox": "",
    "state": "",
    "country": "",
    "xing": "",
    "linkedin": "",
    "facebook": "",
    "twitter": "",
    "attachments": [],
    "type": "",
    "fail": false,
    "sequenceNumber": null,
    "snapaddyParserResponseText": "",
    "orientation": "",
    "failInternet": false,
    "qrScan": false,
    "questionnaireId": "a9egORnjNjnpJk46",
    "finished": false,
    "exportedToExcel": false,
    "exportedToIntegration": false,
    "checked": false,
    "checkedBy": "",
    "checkedAt": null,
    "imageLocal": "",
    "isParentParticipant": false,
    "isDeprecatedTypeOfParticipant": false,
    "childrenSequenceNumberCounter": 0,
    "takenInOfflineMode": false,
    "answeredQuestions": []
  }, {
    "id": "eKvJ6yPpO9WR1qkm",
    "created": "2017-02-24T15:08:02.000Z",
    "firstName": "",
    "lastName": "",
    "organization": "",
    "email": "",
    "phone": "",
    "bcImage": "",
    "bcImageBackside": "",
    "bcImageLocal": "",
    "bcImageBacksideLocal": "",
    "bcChecked": null,
    "createdByUserId": "",
    "drawing": "",
    "image": "",
    "note": "",
    "gender": null,
    "title": "",
    "position": "",
    "mobile": "",
    "fax": "",
    "website": "",
    "vat": "",
    "street": "",
    "city": "",
    "zip": "",
    "poBox": "",
    "state": "",
    "country": "",
    "xing": "",
    "linkedin": "",
    "facebook": "",
    "twitter": "",
    "attachments": [],
    "type": "",
    "fail": false,
    "sequenceNumber": null,
    "snapaddyParserResponseText": "",
    "orientation": "",
    "failInternet": false,
    "qrScan": false,
    "questionnaireId": "a9egORnjNjnpJk46",
    "finished": true,
    "exportedToExcel": true,
    "exportedToIntegration": false,
    "checked": false,
    "checkedBy": "",
    "checkedAt": null,
    "imageLocal": "",
    "isParentParticipant": false,
    "isDeprecatedTypeOfParticipant": false,
    "childrenSequenceNumberCounter": 0,
    "takenInOfflineMode": false,
    "answeredQuestions": []
  }, {
    "id": "9zkArmPL1Mne1jK2",
    "created": "2017-05-04T08:10:00.000Z",
    "firstName": "Max",
    "lastName": "Mustermann",
    "organization": "snapADDY GmbH",
    "email": "info@snapaddy.com",
    "phone": "+4993146621200",
    "bcImage": "/visitreport/v1/attachment/z5n8jv4JjN4wdyJe/q736NRWjwK0nbgKd/cf621dcc681c954ac379cf74ede32b39422ec94a440494b193acb7f3062bd35e481e9021756321be.jpg",
    "bcImageBackside": "",
    "bcImageLocal": "",
    "bcImageBacksideLocal": "",
    "bcChecked": false,
    "createdByUserId": "qjrGpdE8XE0Vwv74",
    "drawing": "/visitreport/v1/attachment/z5n8jv4JjN4wdyJe/q736NRWjwK0nbgKd/0ab7084b983216754234b04e73bb38bad91eb41c2c5c76f1fb6e1ab5f2032d3e6a233a666fffb1a0.jpg",
    "image": "",
    "note": "dfgsdgsdfgsdfgsdfgsdf",
    "gender": 0,
    "title": "Dr.",
    "position": "Test-Eintrag",
    "mobile": "+4917600000000",
    "fax": "+4993146621219",
    "website": "",
    "vat": "DE815576732",
    "street": "Juliuspromenade 3",
    "city": "Würzburg",
    "zip": "97070",
    "poBox": "",
    "state": "BY",
    "country": "DE",
    "xing": "",
    "linkedin": "",
    "facebook": "",
    "twitter": "",
    "attachments": [],
    "type": "",
    "fail": false,
    "sequenceNumber": null,
    "snapaddyParserResponseText": "",
    "orientation": "",
    "failInternet": false,
    "qrScan": false,
    "questionnaireId": "a9egORnjNjnpJk46",
    "finished": true,
    "exportedToExcel": true,
    "exportedToIntegration": true,
    "checked": false,
    "checkedBy": "",
    "checkedAt": null,
    "imageLocal": "",
    "isParentParticipant": false,
    "isDeprecatedTypeOfParticipant": false,
    "childrenSequenceNumberCounter": 0,
    "takenInOfflineMode": false,
    "answeredQuestions": [{
      "question_id": "XvxYlene2QE28Qyj",
      "answers": [{
        "answer_id": "pmgqyjW7kbWkD829",
        "selected_question_option_id": "VmMp7anzorE9X5L4",
        "question_option_type": "Text",
        "texts": {
          "de": "21-100 Mitarbeiter",
          "en": "21-100 Employees"
        },
        "value": "",
        "validation": {}
      }]
    }, {
      "question_id": "X5Dl2aEbvBEN8k9B",
      "answers": [{
        "answer_id": "z5NjdLEYG4Pwm74J",
        "selected_question_option_id": "gVb65mPJaRWa9wpx",
        "question_option_type": "Text",
        "texts": {
          "de": "Großhändler",
          "en": "Großhändler"
        },
        "value": "",
        "validation": {}
      }]
    }, {
      "question_id": "dxzyOGP3lqnaZ658",
      "answers": [{
        "answer_id": "gMjrBAPDV8ER8LKb",
        "selected_question_option_id": "X5Dl2aEbddPN8k9B",
        "question_option_type": "Text",
        "texts": {
          "de": "Kälte",
          "en": "Cold"
        },
        "value": "",
        "validation": {}
      }, {
        "answer_id": "G04qbeE0GonB1R6D",
        "selected_question_option_id": "dxzyOGP3ovPaZ658",
        "question_option_type": "Text",
        "texts": {
          "de": "Lüftung",
          "en": "Ventilation"
        },
        "value": "",
        "validation": {}
      }, {
        "answer_id": "qrzok9Pyvpnjg3Z1",
        "selected_question_option_id": "gVb65mPJamWa9wpx",
        "question_option_type": "Text",
        "texts": {
          "de": "Heizung",
          "en": "Heating"
        },
        "value": "",
        "validation": {}
      }]
    }, {
      "question_id": "aXyq6JEg6gneRDAQ",
      "answers": [{
        "answer_id": "ZwDY07WrD6nRLGo6",
        "selected_question_option_id": "aXyq6JEgZjneRDAQ",
        "question_option_type": "Text",
        "texts": {
          "de": "",
          "en": ""
        },
        "value": "",
        "validation": {}
      }]
    }, {
      "question_id": "VmMp7anz32E9X5L4",
      "answers": [{
        "answer_id": "KdR5wanwbAP1V4mB",
        "selected_question_option_id": "qrzok9PyNdnjg3Z1",
        "question_option_type": "Text",
        "texts": {
          "de": "Minikatalog",
          "en": "Mini catalogue"
        },
        "value": "",
        "validation": {}
      }, {
        "answer_id": "Vk5JO7WoYXnxvaQq",
        "selected_question_option_id": "JM9gk2WND0n8NDxZ",
        "question_option_type": "Text",
        "texts": {
          "de": "Katalog Wärmestrahler",
          "en": "Cataloue Heating radiator"
        },
        "value": "",
        "validation": {}
      }, {
        "answer_id": "5wbzdVnZBdnOjQaB",
        "selected_question_option_id": "Vk5JO7Wo0RPxvaQq",
        "question_option_type": "Text",
        "texts": {
          "de": "Broschüre Industrie",
          "en": "brochure Industrie"
        },
        "value": "",
        "validation": {}
      }, {
        "answer_id": "JM9gk2WNbGW8NDxZ",
        "selected_question_option_id": "X5Dl2aEbdgPN8k9B",
        "question_option_type": "Text",
        "texts": {
          "de": "Broschüre SIRe",
          "en": "brochure SIRe"
        },
        "value": "",
        "validation": {}
      }]
    }]
  }],
  "questions": [{
    "id": "v1pZ4JPvJ4PgXRm0",
    "mappingId": "v1pZ4JPvJ4PgXRm0",
    "groupId": "eKvJ6yPpv9ER1qkm",
    "sequenceNumber": 1,
    "column": 0,
    "texts": {
      "de": "Infos per E-Mail (wie z.B. Newsletter)",
      "en": "Email Newsletter"
    },
    "questionType": 0,
    "settings": {}
  }, {
    "id": "aXyq6JEg6gneRDAQ",
    "mappingId": "aXyq6JEg6gneRDAQ",
    "groupId": "eKvJ6yPpv9ER1qkm",
    "sequenceNumber": 1,
    "column": 2,
    "texts": {
      "de": "Konkreter Handlungsbedarf",
      "en": "Call to Action"
    },
    "questionType": 3,
    "settings": {}
  }, {
    "id": "Q96432E19xERr7al",
    "mappingId": "Q96432E19xERr7al",
    "groupId": "eKvJ6yPpv9ER1qkm",
    "sequenceNumber": 0,
    "column": 1,
    "texts": {
      "de": "Konkreter Handlungsbedarf",
      "en": "Call to Action"
    },
    "questionType": 0,
    "settings": {}
  }, {
    "id": "9zkArmPLLjPe1jK2",
    "mappingId": "9zkArmPLLjPe1jK2",
    "groupId": "eKvJ6yPpv9ER1qkm",
    "sequenceNumber": 0,
    "column": 0,
    "texts": {
      "de": "Persönliche Beratung gewünscht",
      "en": "Personal Consultation?"
    },
    "questionType": 0,
    "settings": {}
  }, {
    "id": "gQjMayPON1WKoxYm",
    "mappingId": "gQjMayPON1WKoxYm",
    "groupId": "3mg2X7nXQ6EJ065K",
    "sequenceNumber": 0,
    "column": 0,
    "texts": {
      "de": "Info-Material zusenden",
      "en": "Info Material"
    },
    "questionType": 1,
    "settings": {}
  }, {
    "id": "qjrGpdE8XjE0Vwv7",
    "mappingId": "qjrGpdE8XjE0Vwv7",
    "groupId": "3mg2X7nXQ6EJ065K",
    "sequenceNumber": 1,
    "column": 1,
    "texts": {
      "de": "Systemair",
      "en": "Systemair"
    },
    "questionType": 1,
    "settings": {}
  }, {
    "id": "VmMp7anz32E9X5L4",
    "mappingId": "VmMp7anz32E9X5L4",
    "groupId": "3mg2X7nXQ6EJ065K",
    "sequenceNumber": 2,
    "column": 2,
    "texts": {
      "de": "Frico",
      "en": "Frico"
    },
    "questionType": 1,
    "settings": {}
  }, {
    "id": "XvxYlene2QE28Qyj",
    "mappingId": "XvxYlene2QE28Qyj",
    "groupId": "lONdy0nR9xPRB4xg",
    "sequenceNumber": 0,
    "column": 1,
    "texts": {
      "de": "Größe des Unternehmens",
      "en": "Company Size"
    },
    "questionType": 0,
    "settings": {}
  }, {
    "id": "X5Dl2aEbvBEN8k9B",
    "mappingId": "X5Dl2aEbvBEN8k9B",
    "groupId": "lONdy0nR9xPRB4xg",
    "sequenceNumber": 0,
    "column": 0,
    "texts": {
      "de": "Kundenkategorie",
      "en": "Customer-type"
    },
    "questionType": 0,
    "settings": {}
  }, {
    "id": "dxzyOGP3lqnaZ658",
    "mappingId": "dxzyOGP3lqnaZ658",
    "groupId": "lONdy0nR9xPRB4xg",
    "sequenceNumber": 1,
    "column": 2,
    "texts": {
      "de": "Mitarbeiter, die im bereich Lüftung/Heizung/Kälte arbeiten:",
      "en": "Employees working in Heating / AC department"
    },
    "questionType": 2,
    "settings": {}
  }, {
    "id": "gVb65mPJ02Ea9wpx",
    "mappingId": "gVb65mPJ02Ea9wpx",
    "groupId": "lONdy0nR9xPRB4xg",
    "sequenceNumber": 2,
    "column": 2,
    "texts": {
      "de": "Wie ist die prozentuale Aufteilung der Bereiche?",
      "en": "Work Distribution"
    },
    "questionType": 2,
    "settings": {}
  }]
}

Further Help

In case you need more information, please contact our support team.