Changelog

2 minutes reading time

This document is the record of all the changes in the Configuration API starting from version 3.0. What you won't find here is the list of changes between versions 2.0 and 3.0 of the Configuration API.

Switching from v2.0 to v3.0 was more than an upgrade - it was rather a migration. That's why some parts of the configuration, such as managing canned responses or greetings, can be done only via the Configuration API v2, while other, like managing webhooks or properties, via the Configuration API v3.

Since the migration is still ongoing, different parts will be successively moved from the Configuration API v2.0 to v3.x.

[v3.3] - Developer preview

Agents

  • In Create Agent, there's a new notification option, incoming_message_for_focused_chat.

Auto access

Bots

  • The Delete Bot method had the bot_agent_id parameter renamed to id.
  • The Get Bot method had the bot_agent_id parameter renamed to id.
  • The Create Bot method has a new parameter, timezone. It's required when used with work_scheduler; otherwise optional.
  • The Update Bot method has a new parameter, timezone. It's required when used with work_scheduler; otherwise optional.

Properties

Webhooks

[v3.2] - 2020-06-18

Agents

Bots

  • The Create Bot Agent method was renamed to Create Bot.
  • The Create Bot method:
    • no longer accepts the status parameter. The initial value is now __offline__.
    • allows to set work_scheduler for Bots.
  • The Update Bot Agent method was renamed to Update Bot.
  • The Update Bot method:
    • no longer accepts the status parameter. To change the Bot's status, use Set Routing Status from the Agent Chat API.
    • allows to set work_scheduler for Bots.
  • You can now update another Bot within the same license. To do that, call the Update Bot method; requires the agents-bot--all:rw scope.
  • Other method renames include:

Groups

Properties

Webhooks

[v3.1] - 2019-09-17

Changed

  • The data field in webhooks was renamed to payload.