Nexus Webhooks


This guide outlines how to integrate with the Engagement Hub’s webhook infrastructure to receive real-time updates on Visit data via the v3 API.

🧩 What Is a Webhook?

A webhook is a way for our system to send data to your system automatically when certain events happen—specifically, when a Visit is created or updated in the Engagement Hub.

⚙️ How It Works

  1. A Visit is created or updated in the Engagement Hub.
  2. Within 30 seconds, a webhook sends a notification containing the Visit ID to your endpoint.

  3. Your system should immediately call the Visit Details API to retrieve full Visit data:

    Endpoint:



    GET https://api.nexuscenter.io/v3/Visits/{visitID}

    Operation: GET /Visits/{visitID}

    Response model: VisitFull  (includes full visit, attendees, agenda, rooms, and customers)

  4. Your system processes and stores the updated Visit information.

    To ensure data integrity, perform a nightly backup sync using the following endpoint:

    Endpoint:



  5. GET https://api.nexuscenter.io/v3/Visits

    Query Parameters:

    • StartDate  (ISO 8601 date)
    • EndDate  (ISO 8601 date)

    • Optional flags to include extended visit data (e.g., IncludeCustomers , IncludeAttendees , etc.)

      Response model: VisitExtendedPaginatedResponse

      This ensures your system reconciles any missed updates.

📌 Timing and Data Latency

Webhook notifications are near real-time, typically reflected in your system within 1–2 minutes.

🔐 Endpoint Setup

Provide a POST-capable webhook URL in the format below:



https://bs-mw-webhook.hub.nexuscenter.io/<tenantName>/?briefingId=

Example:



https://bs-mw-webhook.hub.nexuscenter.io/Twilio/?briefingId=

  • The system appends the Visit ID to the briefingId  query parameter when invoking your webhook.
  • No data is sent in the request body.

📥 What You Need to Provide

To enable your webhook integration, please supply:




Parameter

Description
Tenant Name Used to construct the webhook endpoint URL
Webhook Endpoint URL Must accept POST  requests
DataTrigger 1
DataPacket 1
HttpMethod POST



🧪 Webhook Trigger Criteria

Webhooks are triggered automatically whenever Visit-related data changes, including:

  • Visit metadata (Name, Type, Time Zone, Start/End Dates & Times)
  • Room assignments, agenda items, and meals
  • Attendees, Accounts, or Team Members
  • Topics, Speakers, and related overrides



Purpose

HTTP Method & Endpoint

Response Schema
Fetch a single Visit’s full details GET /Visits/{visitID} VisitFull
Retrieve Visit summaries (e.g., for nightly sync) GET /Visits VisitExtendedPaginatedResponse
Get Visit Attendees GET /Visits/{visitID}/Attendees ArrayOfVisitAttendee
Get Visit Customers GET /Visits/{visitID}/Customers ArrayOfVisitCustomerExtended



✅ Example Flow

Webhook Trigger:

POST https://bs-mw-webhook.hub.nexuscenter.io/Twilio/?briefingId=12345

Client Reaction:



GET https://api.nexuscenter.io/v3/Visits/12345 Authorization: Bearer <access_token>

Response: (simplified)



{  "VisitID": 12345,  "VisitName": "Twilio Executive Briefing",  "VisitStart": "2025-11-02T14:00:00Z",  "Attendees": [...],  "Customers": [...],  "Rooms": [...],  "AgendaItems": [...] }