API reference

Apps platform

Apps, cards, KViews, inbound email/form/web hooks and outbound webhooks with their transactions.

Server https://api.kustomerapp.com/v1 · 40 operations

This category describes endpoints related to creating private and public apps for the Kustomer App Directory and Kustomer App Marketplace.

To learn more, see the Kustomer Apps Platform developer documentation.

Apps

An app is a packaged integration, described in one JSON app definition, that adds custom objects, views, workflows, hooks and settings to a Kustomer org. These endpoints list the app versions your org can install and the apps it has installed, along with the state of every component each install created.

getGet Installed Apps/v1/appsgetGet Installed Apps (By Specific Version)/v1/apps/{appVersion}getGet Available Apps/v1/apps/availablegetGet Available App/v1/apps/available/{appVersion}

Cards

A card is a web page you host that Kustomer loads in an iframe in the agent desktop next to a customer, conversation, company or custom object. Cards are the older way to embed your own UI; new integrations should use a KView with a DynamicCard instead.

getGet Cards/v1/cardsgetGet Card/v1/cards/{id}putUpdate a Card/v1/cards/{id}DELDelete a Card/v1/cards/{id}postCreate a Card/v1/cards/availablepostInstall a Card/v1/cards/available/{id}/install

Hooks (Email Hooks)

An inbound hook is an address that Kustomer hosts for you, either a URL or an email address. Whatever you send to it becomes an event that a workflow can use as its trigger, to create or update customers, conversations or custom objects.

getGet Email Hooks/v1/hooks/emailpostCreate Email Hook/v1/hooks/emailgetGet an Email Hook by ID/v1/hooks/email/{id}patchUpdate Email Hook/v1/hooks/email/{id}getGet Email Hook Transactions/v1/hooks/email/{id}/transactions

Hooks (Form Hooks)

getGet Form Hooks/v1/hooks/formpostCreate Form Hook/v1/hooks/formgetGet a Form Hook by ID/v1/hooks/form/{id}patchUpdate Form Hook/v1/hooks/form/{id}postCreate Form Hook Transaction/v1/hooks/form/{hash}getGET Form Hook Transactions/v1/hooks/form/{id}/transactionspostCreate Form Hook Org Transaction/v1/hooks/form/{org}/{hash}

Hooks (Web Hooks)

getGet Web Hooks/v1/hooks/webpostCreate Web Hook/v1/hooks/webgetGet a Web Hook by ID/v1/hooks/web/{id}patchUpdate Web Hook/v1/hooks/web/{id}postCreate Web Hook Transaction/v1/hooks/web/{hash}getGet Web Hook Transactions/v1/hooks/web/{id}/transactions

KViews (Klass Views)

A KView (Klass View) is a view template that Kustomer renders in the agent desktop for one type of record, such as a card in the insights panel or the body of a custom object in the timeline. These endpoints read the KViews in your org, edit them and set the order they appear in.

getGet KViews/v1/kviewsgetGet KViews by Resource/v1/kviews/{resource}putUpdate KViews Order/v1/kviews/{resource}/{context}/orderputUpdate KView/v1/kviews/{resource}/{id}

Outbound Web Hooks (Transactions)

An outbound webhook is a subscription that tells Kustomer to send certain events, such as a new conversation or an updated customer, to your HTTPS endpoint as they happen. Transactions are the log of recent delivery attempts, used to debug failures.

getList Transactions/v1/outbound-webhooks/transactionsgetList Transactions For Webhook/v1/outbound-webhooks/{webhookId}/transactions

Outbound Web Hooks

getList Outbound Webhooks/v1/outbound-webhookspostCreate Outbound Webhook/v1/outbound-webhooksgetList Subscribable Events/v1/outbound-webhooks/eventsgetGet Outbound Webhook/v1/outbound-webhooks/{id}patchUpdate Outbound Webhook/v1/outbound-webhooks/{id}DELDelete Outbound Webhook/v1/outbound-webhooks/{id}