Skip to main content

How does our Custom API integration work?

Written by Laura Hillman

In order to implement an API connection, your Unibuddy main widget needs to be embedded on your website.

Once the main widget is launched, the URL where the widget is located should be shared with your Customer Success Manager.

PLEASE NOTE: You can also provide the Unibuddy Support team with your widget URL via the chat bubble located in your University Dashboard.

Once your widget has been embedded and your widget URL has been added to the backend, you can then move forward to create your custom API connection with Unibuddy.

A pull method can be used when creating your custom connection to Unibuddy's API.

If you opt for the pull method, your CRM will pull the data (as a CSV file) from Unibuddy into your CRM. The data file is pulled at a set time daily and will then need to be manually processed in the CRM.

Using this connection will not allow for auto-updates when lead data is created, updated, or deleted.

Data availability

Lead Attribution fields (ub_source, ub_medium, ub_campaign and ub_content) and Community interaction data are not included in the Custom API response. Some of these data points may be available through Unibuddy’s supported CRM integrations. However, detailed Community engagement data, such as the number of posts made or Communities and Spaces joined, is not currently available through any integration method.

Did this answer your question?