Notification channels

Notification channel list

GET https://app.hightouch.ai/api/notifications/channels/

Query Parameters

Name	Type	Description
shop_id	integer	Store ID
is_active	boolean	Show only active/inactive
tags	array	Filter by notification channel tags
limit	integer	Number of records (max. 100)
offset	integer	Shift in records
search	string	Search bar by email/ Telegram ID/ Channel ID

200

{
  "status": "ok",
  "result": {
    "count": 6,
    "next": null,
    "previous": null,
    "results": [
      {
        "id": 120,
        "shop_id": 2,
        "is_active": true,
        "type": {
          "id": 2,
          "name": "Telegram"
        },
        "email": null,
        "tg_user_id": "1071807456",
        "tags": [],
        "tg_user_name": "Кариша"
      },
      ...
    ]
  }
}

Add notification channel

POST https://app.hightouch.ai/api/notifications/channels/

There are two types of notification channels: {"id": 1} - Send to email {"id": 2} - Send to the Telegram When selecting each type, be sure to specify the field email or tg_user_id accordingly. You can find out your Telegram ID by texting this bot.

Request Body

Name	Type	Description
shop_id	integer	Store ID
is_active	boolean	Is the channel active
tags	array	A list of tags to mark the channel with
type	object	Type, for example: {"id": 2}
email	string	Email for notification
tg_user_id	integer	Telegram user ID

200

{
  "status": "ok",
  "result": {
    "id": 67,
    "shop_id": 2,
    "is_active": false,
    "type": {
      "id": 2,
      "name": "Telegram"
    },
    "email": null,
    "tg_user_id": "105023594",
    "tags": [
      {
        "id": 224,
        "shop_id": 2,
        "name": "0.2 КВИЗ"
      },
      {
        "id": 226,
        "shop_id": 2,
        "name": "0.4 Чат-центр"
      }
    ],
    "tg_user_name": "Владимир "
  }
}

Change notification channel

PATCH https://app.hightouch.ai/api/notifications/channels/:id/

Path Parameters

Name	Type	Description
id	integer	Notification channel ID

Request Body

Name	Type	Description
shop_id	integer	Store ID
is_active	boolean	Active?
tags	array	Tag list
type	object	Type of the channel
email	string	Email
tg_user_id	integer	Telegram user ID

200

{
  "status": "ok",
  "result": {
    "id": 67,
    "shop_id": 2,
    "is_active": false,
    "type": {
      "id": 2,
      "name": "Telegram"
    },
    "email": null,
    "tg_user_id": "105023594",
    "tags": [
      {
        "id": 224,
        "shop_id": 2,
        "name": "0.2 КВИЗ"
      },
      {
        "id": 226,
        "shop_id": 2,
        "name": "0.4 Чат-центр"
      }
    ],
    "tg_user_name": "Владимир "
  }
}

Delete notification channel

DELETE https://app.hightouch.ai/api/notifications/channels/:id/

Path Parameters

Name	Type	Description
id	integer	Notification channel ID

204