Integrate Visitly With Webhooks

Modified on Sun, 26 Jan at 6:05 PM


Visitly Configuration

1. Log in to the Visitly Dashboard

2. Navigate to Integrations > Webhook from the left-hand menu.

3. Click Add and provide the following details:

  • POST URL: Enter the URL where Visitly will send the visitor data.
  • Headers (Optional): Add authentication headers and values if needed.



4. Click Save.


Once configured, Visitly will send a POST request with visitor data to the specified URL whenever a visitor signs in or signs out.


Data Sent By Visitly

Visitly sends the following JSON data:


Sign In Event Example


{
"event":"Sign In",
"visitData":{
"id":"dsfdsfdfds-0e17-433c-87de-63ce9b859f18",
"fullName":"John Smith",
"email":"john@example.com",
"hostUserId":"ddsffsfsd-61f9-46af-aefc-9397821feda2",
"hostEmail":"emily@visitly.io",
"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 Example

{
"event":"Sign Out",
"visitData":{
"id":"dsfdsfdfds-0e17-433c-87de-63ce9b859f18",
"fullName":"John Smith",
"email":"john@example.com",
"hostUserId":"ddsffsfsd-61f9-46af-aefc-9397821feda2",
"hostEmail":"emily@visitly.io",
"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"
}
]
}
}


For further assistance, please reach out to Visitly Support.



Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article