Getting Started with xAPI


Setting up a new xAPI Integration

  1. Navigate to the Integration Portal page, and enter in your API key. For API Key information and best practices please refer to this page.

  2. If you do not have subscriptions to any Pluralsight powered integrations, the page will prompt you to select your LMS/LXP provider. If you do have pre-existing subscriptions, they will display on the page and you will be able to edit them.

  3. Fill out the required information in the form.

    • Provider: Determines which LMS/LXP provider the integration will use. LMS/LXP Providers are responsible for setting up configuration for your xAPI statements.

    • Technical Emails: The email(s) where notifications will be sent regarding the integration. To use multiple emails, seperate the emails with a comma: example1@test.com, example2@test.com

    • Statement URL: The URL where the xAPI statements will be sent to; Should be provided by receiving LMS/LRS.

    • Authentication URL: The URL to retrieve an access token; Should be provided by receiving LMS/LRS.

    • Client ID: The client ID to retrieve an access token; Should be provided by receiving LMS/LRS.

    • Client Secret: The client password to retrieve an access token; Should be provided by receiving LMS/LRS (Note: If given the option, set your client credentials to have the xapi:write scope).

    • Refresh Token: Some providers require the use of a refresh token. If your provider uses this, a new field will appear when configuring your integration; Should be provided by receiving LMS/LRS.

    • Status: Determines whether your integration is active or not. If integration is set to Paused, xAPI statements will NOT be sent to your statement URL.

  4. Click the Save button. Your xAPI subscription is now running.




Supported Content Types and Verbs


  • Video Course (Latency: Up to one minute)

  • Program Subject (Latency: Up to 30 minutes)

  • We support both the completed and progressed verbs. The utilization of these verbs depends on your LMS/LXP.




Troubleshooting

Possible Errors

  • Invalid Credentials: This error indicates that the integration was unable to fetch an access token. Be sure that the Client Id, Client Secret, Refresh Token (If provider utlizes this field) and Authentication URL are all correct.
  • Error via email.: These errors come from your LMS/LXP/Provider when we attempt to fetch an access token or send an xAPI statement to your endpoint. We do not create these errors, we just pass them along to your technical contact via email. This is to help get your LMS/LXP back into a state where we can continue sending xAPI statements successfully. For questions about the error messages you receive from these emails, and how to fix them, contact your LMS/Provider.



Error Handling Policy

We resend any rows that failed to be delivered to your LMS/LXP provider once a day. An errored statement will be resent at most seven times, if not successful. If the xAPI statement fails to send after the seventh retry, it will stay in our logs and not be retried by our automated process. If we detect any changes to your xAPI subscription, we will resend all errored statements that we have in our log, regardless of the amount retry attempts it may have.



Notification Policy

In the event of any 4xx, we will alert the technical contacts in the integration via email. To avoid spam, we will only send up to one email per 24 hours if an error occurs. We only send email notifications during business days.