App Scan created Hook

Receive information about an app scan that was created
Event

app_scan_created

HTTP-Method
POST
Purpose
Pushes information about the app scan that has been created to the target URL.
Submitted values

JSON-Array containing the following information:
appConfigurationId - the unique ID of the app configuration that was used to scan the pass

passId - the unique ID of the pass that has been scanned. This may be empty if a unkown pass has been scanned.

scanStatus - the status of the scan.

0 means the pass was known and has been voided after it has been scanned.

1 means the pass was known but has been voided (used) before.

2 means the pass was known and the attendance was saved. The pass stays valid in this case for further scans.

3 means a pass could not found using the barcode value scanned.

createdOn - the date and time when the app scan has been created (aka. the time of the visit)

scannedBarcodeValue - the value of the barcode that has been scanned

deviceName - the name of the device were the Passcreator Companion app was used to scan the pass

passGeneratedId - the unique ID that is generated for every pass that is created in Passcreator and might be used in the barcode

passSearchString - a searchable representation of the pass's content separated by pipe-symbol

passVoided - true if the pass is valid, false if it isn't

passUserProvidedId - the user custom identifier that can be specified when creating passes

passTemplateGuid - if a pass was found when scanning the barcode the guid of the pass's template is returned

passTemplateName - if a pass was found when scanning the barcode the name of the pass's template is returned

appScanId - the UUID of the app scan itself

additionalProperties - if there are additional properties for the app configuration, the values that have been specified are returned as key-value pairs. The key is the key of the additional property, the value is the actual value the user has specified.

Example payload

  1. {
  2. "appConfigurationId": "c98c4396-305c-4633-9d1f-6b3cbb241ec0",
  3. "passId": "f76a57e1-07e4-46e3-b6bd-e377ab6999bf",
  4. "scanStatus": 2,
  5. "createdOn": "2018-03-19 08:00:00",
  6. "scannedBarcodeValue": "5a79ed89aceda1.75359555",
  7. "passGeneratedId": "5a79ed89aceda1.75359555",
  8. "scannedBarcodeValue": "5a79ed89aceda1.75359555",
  9. "passUserProvidedId": "567-8466",
  10. "passTemplateGuid": "01968ef1-c2cf-4e3c-b61f-334d2473a5e8",
  11. "passTemplateName": "My template",
  12. "appScanId": "6d9e812b-50f2-4794-92b9-d1bd88abc3a5",
  13. "deviceName": "My iPhone",
  14. "passVoided": false,
  15. "additionalProperties": {
  16. "0": "66",
  17. "1": 0
  18. }
  19. }