Kustomer | Yext Hitchhikers Platform
Overview
Use the Kustomer source to pull in your Articles, Conversations, and Messages.
Operations
This source uses the Kustomer API for the following operations:
- Fetch Articles: fetch knowledge base articles
- Fetch Conversations: fetch customer conversations
- Fetch Messages: fetch customer messages
Requirements
You are required to input your API key and Kustomer Knowledge Base domain.
To generate an API key, navigate to Settings > Security > API Keys. Set the expiration to “No Expiration” and choose the appropriate role for the operation:
- Fetch Articles: org.admin.kb
- Fetch Conversations: org.permission
- Fetch Messages: org.permission
To find your Knowledge Base domain, go to Settings > Knowledge Base > Configuration. Make sure to use the full domain including the https://.
Pagination
Kustomer utilizes cursor-based pagination.
| Cursor | links.next |
| Page Start Value | 0 |
| Detect Cursor In | Response Body |
| Cursor Type | Relative URL |
Limits and Other Info
Rate Limits
A rate limit of 300 API calls per minute is set by default for all pricing tiers.
Headers
The API request includes a hard-coded header to return the request body in JSON format.
| Header Key | Content-Type |
| Header Value | application/json |
Feedback
<% elem.innerText %>