Attendees Data Feed API | Cadence Support Center

In the dynamic realm of event management, flexibility and adaptability are paramount. Event Cadence recognizes that every event organizer has unique needs and platform preferences, whether stemming from primary data repositories, specialized ticket sales, or established partnerships. That's why, alongside our own robust registration capabilities, we've forged integrations with industry leaders like Cvent and Eventbrite. For those seeking even more customization, our Attendees Data Feed API awaits.

Why Choose the Attendees Data Feed API?

Real-time Data Sync: Always have up-to-date attendee details.
Enhanced Personalization: Tailor experiences with granular attendee data.
Ease of Management: Minimize manual errors with automated data processes.
Secure Data Handling: Rely on stringent authentication and authorization measures to keep attendee data safe

Dive into this documentation to understand how our API, specifically designed for Event Cadence, allows seamless acceptance of attendee data via HTTP push. From its support for JSON objects and plain key-value collection payload formats to authorization through the payload body or by using the Api-Key HTTP header, enhance your event management capabilities with us. We're here to collaborate, broadening your integration horizons for unmatched event success.

API Endpoint

To use this API, you will need the API Gateway address specific to your event. Please contact the Customer Success team to obtain this address.

Authentication

Authorization for accessing the API can be done using a pre-generated API key, which will be provided to you by our customer success team for your event. There are two ways to pass the API key:

Payload Body: Include the API key in the payload body under the key field.
HTTP Headers: Add an Api-Key header with your API key.

Payload Formats

JSON Object Structure

The API accepts JSON objects with the following structure:

{
  "profile": {
    "thirdPartyId": null,
    "prefix": null,
    "firstName": null,
    "lastName": null,
    "email": null,
    "phone": null,
    "website": null,
    "facebook": null,
    "twitter": null,
    "linkedin": null,
    "instagram": null,
    "title": null,
    "department": null,
    "company": null,
    "city": null,
    "state": null,
    "country": null,
    "assistantName": null,
    "assistantPhone": null,
    "assistantEmail": null,
    "motto": null,
    "biography": null,
    "customFields": [
      {
        "fieldName": "cf name",
        "fieldValue": "value"
      }
    ]
  },
  "eventInfo": {
    "groups": {
      "groupNames": [
        "name1"
      ]
    }
  },
  "key": null
}

Plain Key-Value Collection

Alternatively, you can use a plain key-value collection in your JSON payload:

{
  "profile.thirdPartyId": null,
  "profile.prefix": null,
  "profile.firstName": null,
  "profile.lastName": null,
  "profile.email": null,
  "profile.phone": null,
  "profile.website": null,
  "profile.facebook": null,
  "profile.twitter": null,
  "profile.linkedin": null,
  "profile.instagram": null,
  "profile.title": null,
  "profile.department": null,
  "profile.company": null,
  "profile.city": null,
  "profile.state": null,
  "profile.country": null,
  "profile.assistantName": null,
  "profile.assistantPhone": null,
  "profile.assistantEmail": null,
  "profile.motto": null,
  "profile.biography": null,
  "profile.customFields[0].fieldName": "field1",
  "profile.customFields[0].fieldValue": "value1",
  "profile.customFields[1].fieldName": "field2",
  "profile.customFields[1].fieldValue": "value2",
  
  "eventInfo.groups.groupNames.0": "Group1",
  "eventInfo.groups.groupNames.1": "Group2",
  "key": null
}

Please note that the email field is necessary, while all other fields are optional. If any field is not provided, it will not be cleared in Event Cadence, and its value will remain as it was.

Response

HTTP Status 200: If the request is well-formatted and accepted, Event Cadence will respond with a 200 status code.
HTTP Status 401: If the authorization key is invalid, Event Cadence will respond with a 401 status code.
HTTP Status 500: For any other errors, Event Cadence will respond with a 500 status code, and error details will be included in the response body.

Example Usage

Here's an example of how to use this API to send attendee data to Event Cadence:

Request

POST https://your-event-api-gateway.com/attendees
Api-Key: your-api-key
Content-Type: application/json

{
  "profile": {
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe"
  },
  "eventInfo": {
    "groups": {
      "groupNames": ["Group1"]
    }
  }
}

Response

HTTP/1.1 200 OK