Higher Logic has created a Webhook to allow 3rd parties to collect community activities from a Higher Logic Online Community, using the Activity Sync module. There are currently ~300 different activities that are tracked in a Higher Logic Online Community, and these activities can be used in other systems by taking advantage of this Webhook. These requests can be sent in either JSON (default) or XML, and can include any number of fixed request headers.
Once a 3rd party has created an endpoint to accept these activities, they can easily be configured in Higher Logic’s community as an Activity Sync Endpoint.
Each community activity sent via the POST to your endpoint will be a single post entry.
Each activity can have different fields included in the post. Fields of interest include:
- ActivityCode - a code to define this specific activity.
- ActivityDate - the date time when the activity happened.
- ActivityDescription - a short description of what the activity was.
- ContributorKey - the ID in Higher Logic of the user who did this activity.
- ContributorMemberKey - the ID in a related database of the user who did this activity (also referred to as the LegacyContactKey).
- LinkUrl - a link to where the related object can be found More information about the different activities that are written back can be found on Higher Logic’s Support Site.
NOTE: Some activity-type specific fields will be sent that can’t be identified because they are prepended with “pb_”. These are “Property Bag” properties that are meant to hold related information. These are generally ignored since they can’t be normalized and are for informational purposes only.
Given the high volume of activities that can be generated, Higher Logic cannot support any dynamic authentication. Higher Logic supports security through fixed request header(s), which customers should couple with limiting accepted requests to those coming from Higher Logic’s outbound gateway (22.214.171.124).
NOTE: This IP restriction might need to be temporarily disabled during implementation.
Higher Logic Setup
Set up of a Webhook to receive Community Activities requires the purchase of Higher Logic’s Activity Sync module. In the Community Admin, under Activity Sync, Manage Endpoints, a new endpoint will need to be created: Webhook Activity Post.
- Access the Admin interface.
- Navigate to Settings > External Content > Activity Sync.
- Click Create.
Here you can add:
- A name for this endpoint instance of Activity Sync
- Choose which activities are included (this can be changed later)
- The URL to POST the activities
- If you want to send the results in XML format (if this is set to No, JSON is used by default).
If additional headers are needed in post, these are included in the WebhookActivitySynchHeaders Community Configuration Parameter (note these need to be configured by HL Staff). This format of these are:
http://www.webhook.site/ allows one to easily test webhooks and other types of HTTP requests. A unique URL will be created to test against. Higher Logic can setup and instance that points here so you can see example posts from related activities.