Overview
The article serves as an introduction to the Influitive API, explaining its purpose, the authorization process for access, and the wide range of functionalities it offers. It emphasizes the API's ability to log user actions from various external systems, which can trigger rewards and segmentation within Influitive, and invites feedback for documentation improvements.
Information
The Influitive Event API allows user actions that happen within external systems (communities, learning management systems, Marketo, etc) to be logged in Influitive. These actions can then trigger badges, rewards, and/or points to be awarded to advocates. These can then be used for segmentation purposes as well.
Authorization
Most API endpoints (with the exception of AdvocateAnywhere) require the use of an API Token . You can retrieve this token by following these steps:
- Log into your Influitive instance, and click on your name in the top right of the screen, from the dropdown select Integrations
- Find the integration named Influitive API . Enable that integration if it's not currently active.
- Click on Manage . A pop-up will appear with your API Token . All requests to Influitive must include this token in requests, within the Authorization header. Some API calls require an X_ORG_ID , which is also provided in the Influitive API configuration settings.
What Can I Do with the Influitive API?
Click on each link to see the definition, examples, and formatting of these calls. You also have the opportunity to test them using our API explorer. Additionally, check out our full API Documentation at https://influitive.readme.io/reference
AdvocateAnywhere
Approvals: Challenges
Approvals: Rewards
Events
Groups
Manage Advocates
- [GET] Query all members of your AdvocateHub
- [GET] Get details about your own member record
- [GET] Get details about a member identified by email
- [GET] Get details about a member identified by ID
- [POST] Create a member identified by email
- [POST] Invite a member identified by ID
- [POST] Resend invite to a member identified by ID
- [PATCH] Update member referenced by ID
- [PUT] Unsubscribe a contact by email
Manage Challenges
- [POST] Archive a challenge
- [POST] Publish a challenge
- [POST] Unpublish a challenge
- [POST] Create a challenge off a template
Referrals 2.0 API
- [POST] Create a referral
- [PUT] Advance a referral
- [OPTIONS] Advance a referral from Salesforce workflow
- [GET] List of referrals
- [GET] Show one referral
References
- [POST] Create/Update/Complete Reference Challenge
- [POST] Post reference type events
- [GET] Get reference completions
We're looking for ways to improve our API documentation, so we welcome your feedback on the article above and our more developer-focused documentation, found here: https://influitive.readme.io . If there's something you'd like to see added / changed, please contact us!
FAQ
What is the Influitive API used for?
The Influitive API is used to log user actions from external systems such as communities, learning management systems, and Marketo into Influitive, which can then trigger the awarding of badges, rewards, and points, as well as be used for segmentation of advocates.
How do I get authorized to use the Influitive API?
To use most endpoints of the Influitive API, you need to obtain an API token. The AdvocateAnywhere endpoint is an exception that does not require this token.
Where can I find the full documentation for the Influitive API?
The full API documentation for Influitive can be found at https://influitive.readme.io/reference.
Can I test the Influitive API calls before implementing them?
Yes, you can test the API calls using the API explorer provided in the documentation, which allows you to see definitions, examples, and formatting for each API call.
How can I provide feedback on the Influitive API documentation?
Feedback on the Influitive API documentation can be provided by contacting the team through the links provided in the article or the documentation site.
Priyanka Bhotika
Comments