Pendo.io

Pendo Feedback API

Who is this for? This documentation is for developers creating their own integration with [Feedback's](https://www.pendo.io/product/feedback/) API. If you are…

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Who is this for?

This documentation is for developers creating their own integration with Feedback's API. If you are doing a standard integration, there's a really easy Javascript integration that you should know about before you go to the effort of building your own integration.

Authentication

API calls generally need to be authenticated. Generate an API Key at https://feedback.pendo.io/app/#/vendor/settings?section=integrate. This key should then be added to every request as a request header named 'auth-token' (preferred), or as a query parameter named 'auth-token'.

Endpoint

API endpoint is https://api.feedback.eu.pendo.io / https://api.feedback.us.pendo.io depending where your datacenter is located.

Notes

API endpoints are being added to this documentation as needed by customers. If you don't see an endpoint you need please contact support and if it exists we'll publish the docs here. The 'try it out' feature on this documentation page will probably be blocked by your browser because the Access-Control-Allow-Origin header has its value set by the Feedback server depending on your hostname.

Generating client code

This documentation is automatically generated from an OpenAPI spec available here. You can use Swagger to auto-generate API client code in many languages using the Swagger Editor

Endpoints 31

account

  • GETQuery accounts/accounts?limit=0.0&start=0.0&order_dir=asc&order_by=churned
  • GETGet an Account/accounts/:id
  • PUTUpdate an Account/accounts/:id
  • DELETEDelete an Account/accounts/:idThis removes most traces of an Accounts existence from the system.
  • GETGet custom Account tags/accounts/:id/tags
  • POSTOverwrite current custom Account tags with the given tags/accounts/:id/tags
  • DELETEDelete custom Account tags/accounts/:id/tagsRemoves all custom tags associated with the Account

comment

  • GETfetch Comment records/comments?case_id=0get a list of Comment records

feature

  • GETQuery features/features?limit=0.0&start=0.0&order_dir=asc&is_private=true&wanted_by=0&order_by=title&tags=string&products=string
  • GETGet a Feature by ID/features/:id
  • GETGet custom Feature tags/features/:id/tags
  • POSTOverwrite current custom Feature tags with the given tags/features/:id/tags
  • DELETEDelete custom Feature tags/features/:id/tagsRemoves all custom tags associated with the Feature
  • GETSearch features/search?scope=feature&q=string&status=new&tags=string&products=string

system

  • GETHealth check for API/health-check/pingProvides a response for automatic checks that the API and load balancers are healthy

hooks

  • POSTSubscribe to webhooks/hooksUse this endpoint to subscribe to webhooks.
  • POSTUnsubscribe from webhooks/hooks/unsubscribeUse this endpoint to unsubscribe from a webhook

user

  • GETfetch User records/users?role=endUser&account=0&start=0&limit=300&order_by=string&order_dir=ascget a list of User records
  • POSTPing to create or update an EndUser and Account in one call/usersReplicates much of the functionality of the widget ping, allowing callers to create or update User records for End Users. If you call this with a new User…
  • POSTInvite an EndUser (customer)/users/invite_end_user
  • POSTInvite a VendorUser (Team member)/users/invite_vendor_user
  • GETFind a User with a query/users/search?external_id=string&email=string&role=endUser
  • GETGet a User record/users/:id
  • PUTUpdate a User/users/:id
  • DELETEDelete a User/users/:idThis removes most traces of a User's existence from the system. For an EndUser you might want to consider just letting them churn after a period of inactivity.
  • GETGet custom User tags/users/:id/tags
  • POSTOverwrite current custom User tags with the given tags/users/:id/tags
  • DELETEDelete custom User tags/users/:id/tagsRemoves all custom tags associated with the User
  • POSTCreate or update a team member by their external_id/vendor_usersthe POST /vendor_users is very similar to the POST /users/invite_vendor_user but /vendor_users is intended for consumers to refresh team member data…

votes

  • GETGET /votes/votes?user_id=0&feature_id=0&positive=true&negative=true&offset=0.0&limit=0.0
  • POSTupdate specified votes for a User/votesAutomatically subscribes/unsubscribes the User to the specifed feature depending on the quantity value

API details

Base URL
https://api.feedback.eu.pendo.io
Authentication
An API key in the auth-token query parameter
An API key in the auth-token header
Operations
31 operations on 19 pathsGET 14POST 10DELETE 5PUT 2
Main resources
user 12account 7feature 6hooks 2team 2votes 2comment 1system 1
Response formats
application/json
Description format
Swagger 2.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Pendo Feedback API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Pendo Feedback API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the auth-token query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Query accounts” (GET /accounts?limit=0.0&start=0.0&order_dir=asc&order_by=churned), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Pendo Feedback API?

Who is this for? This documentation is for developers creating their own integration with [Feedback's](https://www.pendo.io/product/feedback/) API. If you are… It is listed under E-commerce and has 31 endpoints.

Who publishes the Pendo Feedback API?

It is listed from Pendo.io's public API description (an OpenAPI document), not published by Pendo.io on Swastik Codes. Anyone who controls pendo.io can claim the profile by adding a DNS TXT record.

What is the base URL of the Pendo Feedback API?

Requests go to https://api.feedback.eu.pendo.io. Endpoint paths are added to this base URL.

How do I authenticate with the Pendo Feedback API?

It accepts 2 methods: an API key in the auth-token query parameter; an API key in the auth-token header.

How many endpoints does the Pendo Feedback API have?

31 operations on 19 paths (14 GET, 10 POST, 5 DELETE, 2 PUT). The largest groups are user, account, feature, hooks.

Is forking the Pendo Feedback API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.