notifications
GET /v1/notification-connections
Connected destinations and the routing matrix.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/notification-connections \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
Every destination this organisation has connected - e-mail addresses, Slack channels, Telegram chats - with the full grid of which notification types go to each. The grid is returned COMPLETE rather than as the stored deviations. Only the cells a human switched OFF are persisted (absence means enabled), so a client that had to infer "everything not listed is on" would be re-implementing that default - and two implementations of one decision is how a customer ends up on a ladder nobody chose.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
org_id (query) | string | Нет | The organization to act on. Omitted resolves to your own ONLY when you belong to exactly one organisation; a principal in more than one must name it, or the call is refused `422… |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
connections | NotificationConnection[] | Нет | — |
topics | object[] | Нет | The routing units. TOPICS, not notification types - the matrix used to address a type enum that no notification template declares, so no cell of it could ever have addressed a m… |