Integrations

Create an integration hook

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

Path parameters

workspace_idinteger required

The numeric ID of the workspace

Request body

app_idinteger

The ID of app for which integration hook is being created

inbox_idinteger

The inbox ID, if the hook is an inbox hook

statusinteger

The status of the integration (0 for inactive, 1 for active)

settingsobject

The settings required by the integration

Example request

{
  "app_id": 1,
  "inbox_id": 1,
  "status": 1,
  "settings": {}
}

Response

Success

idstring

The ID of the integration hook

app_idstring

The ID of the integration app

inbox_idstring

Inbox ID if its an Inbox integration

account_idstring

Account ID of the integration

statusboolean

Whether the integration hook is enabled for the account

hook_typeboolean

Whether its an account or inbox integration hook

settingsobject

The associated settings for the integration

Changes

No recorded changes to this operation across all 1 revision of this API.