Создать webhook для организации


POST /v1/organizations/{organization_id}/hooks

Группа: Webhooks


Описание

Позволяет добавить новый webhook в организацию. Подробнее о системе хуков и ее использовании можно прочитать в этой статье.

Тело запроса

Описание добавляемого webhook'а

CreateHook

url: string — «required»
URL-адрес для колбека при событии

secret: string
Секретная фраза для подписки webhook'ов

type: string — «required»
Тип webhook'а

Параметры

Имя Описание Тип Тип данных
organization_id Идентификатор организации path integer
type Тип получаемых webhook'ов (ticket_change / event_change / order_change) query string

Ответ

Отредактированный webhook

WebhooksApiResponse

values: WebhookApiResponse[] — «required»
Массив со списком webhook'ов

WebhookApiResponse

id: integer
Идентификатор webhook'а

organization: integer
Идентификатор организации

url: string
URL-адрес для колбека при событии

status: string
Статус webhook'а

type: string
Тип webhook'а

secret: string
Ключ подписи webhook'а

Права доступа

Необходимые права доступа — edit_organizations_hooks