Using Webhooks

68 views November 28, 2018 November 4, 2019 visadmin 2

Available on plans : Starter, Business, Enterprise

Required Role: Global Administrator

Webhooks allow you to build any custom integrations with Visitly by capturing all the Visitor information when a visitor signs in or sign out.

Login to Visitly Dashboard  and click on Integrations and then Webhooks. Click on Add

Enter the URL where you would like Visitly to POST the visit information when a visitor sign in or sign out. Add optional header and value for authentication purpose and click on Save

Once configured Visitly will post following information to the configured URL whenever a visitor signs in or signs out

Sign In

{
"event":"Sign In",
"visitData":{
"id":"dsfdsfdfds-0e17-433c-87de-63ce9b859f18",
"fullName":"John Smith",
"email":"[email protected]",
"hostUserId":"ddsffsfsd-61f9-46af-aefc-9397821feda2",
"hostEmail":"[email protected]",
"hostName":"Emily Reyes",
"visitorType":"Contractor",
"visitorTypeId":"90d6ebab-44df-4483-ba32-dfsdfsds",
"companyName":"ACME Corp",
"phoneNumber":"1112223333",
"checkinTime":"2019-11-03T21:09:23",
"orgName":"Example Org",
"siteId":"ejjtjy-b9b7-4e36-sdsds-asadda",
"siteName":"Example HQ",
"signedDocumentId":"asagtrh-948a-4078-b47b-56465464",
"signedDocumentURI":"URI",
"checkinMethod":"DEVICE",
"createTime":"2019-11-04T05:09:24+0000",
"modifyTime":"2019-11-04T05:09:24+0000",
"notifyHostFlag":true,
"skipSigningFlag":false,
"privacyConsentType":"",
"visitCustomFields":[
{
"id":"sdadadda-5fa7-4289-967d-sadsadada",
"name":"State of Residence",
"value":"CA",
"orgCustomFieldId":"4354335353-bd2f-48a6-a019-54354353"
}
]
}
}

 

Sign Out

{
"event":"Sign Out",
"visitData":{
"id":"dsfdsfdfds-0e17-433c-87de-63ce9b859f18",
"fullName":"John Smith",
"email":"[email protected]",
"hostUserId":"ddsffsfsd-61f9-46af-aefc-9397821feda2",
"hostEmail":"[email protected]",
"hostName":"Emily Reyes",
"visitorType":"Contractor",
"visitorTypeId":"90d6ebab-44df-4483-ba32-dfsdfsds",
"companyName":"ACME Corp",
"phoneNumber":"1112223333",
"checkinTime":"2019-11-03T21:09:23",
"checkoutTime":"2019-11-03T21:29:33",
"orgName":"Example Org",
"siteId":"ejjtjy-b9b7-4e36-sdsds-asadda",
"siteName":"Example HQ",
"signedDocumentId":"asagtrh-948a-4078-b47b-56465464",
"signedDocumentURI":"URI",
"checkinMethod":"DEVICE",
"createTime":"2019-11-04T05:09:24+0000",
"modifyTime":"2019-11-04T05:09:24+0000",
"notifyHostFlag":true,
"skipSigningFlag":false,
"privacyConsentType":"",
"visitCustomFields":[
{
"id":"sdadadda-5fa7-4289-967d-sadsadada",
"name":"State of Residence",
"value":"CA",
"orgCustomFieldId":"4354335353-bd2f-48a6-a019-54354353"
}
]
}
}

Was this helpful?