Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 3.95 KB

README.md

File metadata and controls

47 lines (28 loc) · 3.95 KB

Pendo Custom Snippets Repository

This library of custom code snippets has been created by Pendo Professional Services, intended to extend the capabilities of Pendo products.

Copyright 2023 Pendo

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Reiterated from license above, all snippets in this library are free to use, and as such, there is NO WARRANTY, SLA or SUPPORT for these snippets. Please do not reach out to Pendo Support for help with these snippets, as custom code is outside of the remit of their team and responsibilities.

For documentation on standard Pendo functionality, please visit the Pendo Help Center.

Any requests to create new snippets, or modify / customize functionality within existing snippets should be forwarded to Pendo Professional Services ([email protected]) for scoping. These will require a custom services contract in order to complete.

Aggregations

This repository contains custom aggregations queries, intended to utilize the Pendo API. These can be used to extract data out of Pendo in a custom format, usually in batch.

Assistance for writing custom aggregations can be provided in the form of a Professional Services Engagement ([email protected])

Guides

This repository contains custom HTML/CSS/JS snippets that can be used to extend the functionality of Pendo Guides. All code, unless otherwise stated, should be inserted into a Custom Code Building Block within a guide in the Pendo Visual Design Studio. The vast majority of these snippets apply only to the Visual Design Studio, as opposed to the legacy Classic Designer.

The sub-directories within this repository are based off of either actions that guides can do (advance a guide, dismiss a guide, delay a guide, etc), or modifications to existing Pendo building blocks or polls (customGuideAssets, guidePolls, etc). Please avoid the zz_deprecated snippets, as there are better ways, often using newer, in-product Pendo functionality, to achieve the same outcome.

Resource Center

This repository contains custom HTML/CSS/JS snippets that can be used specifically to modify functionality of the Pendo Resource Center, or its sub-modules (ie, Announcements, Code Sandboxes, etc). Note that this is different than the legacy Guides Center; snippets for the Guides Center can be found in a sub-directory in this repository, but snippets will not work interchangeably between the two products.

Snippet Modifications

While the primary function of the Pendo Snippet is to initialize the Pendo Agent on your application, it can also be used to inject sitewide modifications to Pendo functionality. There are many potential applications for this, including adding DOM attributes to Pendo guides, modifying guide behaviors, and others that are covered in the Agent API.

Note that this section does NOT cover Pendo Metadata, which is core product functionality and should be handled per the standard snippet initiatlization procedures.