---
title: "Create an integration hook"
method: POST
path: "/v1/workspaces/{workspace_id}/integrations/hooks"
tags: ["Integrations"]
---

# Create an integration hook

`POST /v1/workspaces/{workspace_id}/integrations/hooks`

## Request

- Base URL: `https://api.oxvo.com`
- URL: `https://api.oxvo.com/v1/workspaces/{workspace_id}/integrations/hooks`
- Auth: API key in header `api_access_token`

Create an integration hook

## Path parameters

- `workspace_id` integer, required

## Request body

- IntegrationsHookCreatePayload
  - `app_id` integer: The ID of app for which integration hook is being created
  - `inbox_id` integer: The inbox ID, if the hook is an inbox hook
  - `status` integer: The status of the integration (0 for inactive, 1 for active)
  - `settings` object: The settings required by the integration

## Response `200`

Success

- IntegrationsHook
  - `id` string: The ID of the integration hook
  - `app_id` string: The ID of the integration app
  - `inbox_id` string: Inbox ID if its an Inbox integration
  - `account_id` string: Account ID of the integration
  - `status` boolean: Whether the integration hook is enabled for the account
  - `hook_type` boolean: Whether its an account or inbox integration hook
  - `settings` object: The associated settings for the integration

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/oxvo/apis/oxvo-apis.md) · [All operations](https://skmtc.dev/oxvo/apis/oxvo-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/oxvo/apis/oxvo-apis/revisions/9a8448cbd1fe?raw)