# Apps platform API

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

Source: https://developer.kustomer.com/api/apps-platform

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](https://developer.kustomer.com/docs/apps) 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.

- [Get Installed Apps](https://developer.kustomer.com/api/apps-platform/get-installed-apps.md): `GET /v1/apps`
- [Get Installed Apps (By Specific Version)](https://developer.kustomer.com/api/apps-platform/get-installed-apps-by-specific-version.md): `GET /v1/apps/{appVersion}`
- [Get Available Apps](https://developer.kustomer.com/api/apps-platform/get-available-apps.md): `GET /v1/apps/available`
- [Get Available App](https://developer.kustomer.com/api/apps-platform/get-available-app.md): `GET /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.

- [Get Cards](https://developer.kustomer.com/api/apps-platform/get-cards.md): `GET /v1/cards`
- [Get Card](https://developer.kustomer.com/api/apps-platform/get-card.md): `GET /v1/cards/{id}`
- [Update a Card](https://developer.kustomer.com/api/apps-platform/update-a-card.md): `PUT /v1/cards/{id}`
- [Delete a Card](https://developer.kustomer.com/api/apps-platform/delete-a-card.md): `DELETE /v1/cards/{id}`
- [Create a Card](https://developer.kustomer.com/api/apps-platform/create-a-card.md): `POST /v1/cards/available`
- [Install a Card](https://developer.kustomer.com/api/apps-platform/install-a-card.md): `POST /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.

- [Get Email Hooks](https://developer.kustomer.com/api/apps-platform/get-email-hooks.md): `GET /v1/hooks/email`
- [Create Email Hook](https://developer.kustomer.com/api/apps-platform/create-email-hook.md): `POST /v1/hooks/email`
- [Get an Email Hook by ID](https://developer.kustomer.com/api/apps-platform/get-an-email-hook-by-id.md): `GET /v1/hooks/email/{id}`
- [Update Email Hook](https://developer.kustomer.com/api/apps-platform/update-email-hook.md): `PATCH /v1/hooks/email/{id}`
- [Get Email Hook Transactions](https://developer.kustomer.com/api/apps-platform/get-email-hook-transactions.md): `GET /v1/hooks/email/{id}/transactions`

## Hooks (Form 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.

- [Get Form Hooks](https://developer.kustomer.com/api/apps-platform/get-form-hooks.md): `GET /v1/hooks/form`
- [Create Form Hook](https://developer.kustomer.com/api/apps-platform/create-form-hook.md): `POST /v1/hooks/form`
- [Get a Form Hook by ID](https://developer.kustomer.com/api/apps-platform/get-a-form-hook-by-id.md): `GET /v1/hooks/form/{id}`
- [Update Form Hook](https://developer.kustomer.com/api/apps-platform/update-form-hook.md): `PATCH /v1/hooks/form/{id}`
- [Create Form Hook Transaction](https://developer.kustomer.com/api/apps-platform/create-form-hook-transaction.md): `POST /v1/hooks/form/{hash}`
- [GET Form Hook Transactions](https://developer.kustomer.com/api/apps-platform/get-form-hook-transactions.md): `GET /v1/hooks/form/{id}/transactions`
- [Create Form Hook Org Transaction](https://developer.kustomer.com/api/apps-platform/create-form-hook-org-transaction.md): `POST /v1/hooks/form/{org}/{hash}`

## Hooks (Web 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.

- [Get Web Hooks](https://developer.kustomer.com/api/apps-platform/get-web-hooks.md): `GET /v1/hooks/web`
- [Create Web Hook](https://developer.kustomer.com/api/apps-platform/create-web-hook.md): `POST /v1/hooks/web`
- [Get a Web Hook by ID](https://developer.kustomer.com/api/apps-platform/get-a-web-hook-by-id.md): `GET /v1/hooks/web/{id}`
- [Update Web Hook](https://developer.kustomer.com/api/apps-platform/update-web-hook.md): `PATCH /v1/hooks/web/{id}`
- [Create Web Hook Transaction](https://developer.kustomer.com/api/apps-platform/create-web-hook-transaction.md): `POST /v1/hooks/web/{hash}`
- [Get Web Hook Transactions](https://developer.kustomer.com/api/apps-platform/get-web-hook-transactions.md): `GET /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.

- [Get KViews](https://developer.kustomer.com/api/apps-platform/get-kviews.md): `GET /v1/kviews`
- [Get KViews by Resource](https://developer.kustomer.com/api/apps-platform/get-kviews-by-resource.md): `GET /v1/kviews/{resource}`
- [Update KViews Order](https://developer.kustomer.com/api/apps-platform/update-kviews-order.md): `PUT /v1/kviews/{resource}/{context}/order`
- [Update KView](https://developer.kustomer.com/api/apps-platform/update-kview.md): `PUT /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.

- [List Transactions](https://developer.kustomer.com/api/apps-platform/list-transactions.md): `GET /v1/outbound-webhooks/transactions`
- [List Transactions For Webhook](https://developer.kustomer.com/api/apps-platform/list-transactions-for-webhook.md): `GET /v1/outbound-webhooks/{webhookId}/transactions`

## Outbound Web Hooks

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.

- [List Outbound Webhooks](https://developer.kustomer.com/api/apps-platform/list-outbound-webhooks.md): `GET /v1/outbound-webhooks`
- [Create Outbound Webhook](https://developer.kustomer.com/api/apps-platform/create-outbound-webhook.md): `POST /v1/outbound-webhooks`
- [List Subscribable Events](https://developer.kustomer.com/api/apps-platform/list-subscribable-events.md): `GET /v1/outbound-webhooks/events`
- [Get Outbound Webhook](https://developer.kustomer.com/api/apps-platform/get-outbound-webhook.md): `GET /v1/outbound-webhooks/{id}`
- [Update Outbound Webhook](https://developer.kustomer.com/api/apps-platform/update-outbound-webhook.md): `PATCH /v1/outbound-webhooks/{id}`
- [Delete Outbound Webhook](https://developer.kustomer.com/api/apps-platform/delete-outbound-webhook.md): `DELETE /v1/outbound-webhooks/{id}`