Changelog

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.4] - Developer preview

Webhooks

• The source_type filter was added to all webhooks.

[v3.3] - 2021-03-30

Agents

• In Create Agent, there's a new notification option, incoming_message_for_focused_chat.
• The Get Agent method can no longer be used to fetch bots.
• The List Agents method no longer returns bots, only agents.

Auto access

• There are new methods for managing auto access:
  • Add Auto Access
  • List Auto Accesses
  • Delete Auto Access
  • Update 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.
  • had its response format changed; it's now unnested, without the redundant bot_agent level.
  • had the webhooks field removed from the response.
  • had a new parameter, fields, added. It allows to fetch additional bot data.
• The List Bots method:
  • had its response format changed; it's now unnested, without the redundant bot_agent level.
  • had a new parameter, fields, added. It allows to fetch additional bot data.
• The Create Bot method:
  • had a new parameter, timezone, added. It's required when used with work_scheduler; otherwise optional.
  • had a new parameter, owner_client_id, added. It's required when authorizing with PATs; otherwise ignored.
  • had the webhooks parameter removed. To register bot webhooks, use the Register Webhook method.
  • had its response format changed; bot_agent_id was rename to id.
• The Update Bot method:
  • has a new parameter, timezone. It's required when used with work_scheduler; otherwise optional.
  • had the webhooks parameter removed. To register bot webhooks, use the Register Webhook method.

Properties

• The List Group Properties method had the group_id parameter renamed to id.
• The Delete Group Properties method had the group_id parameter renamed to id.
• Properties configuration is now owned by Client Id (integration), not by License, which resulted in the following changes:
  • The Register Properties method was removed.
  • The List Registered Properties method was removed.
  • There are new methods:
    • Register Property
    • Unregister Property
    • Publish Property
    • List Properties

Webhooks

• The List Webhook Names method was added.
• The customer_created webhook was renamed to incoming_customer.
• There are new webhooks:
  • customer_session_fields_updated
  • chat_transferred
• Webhooks are now registered for a Client ID and need to be enabled for a specific License. It resulted in the following changes:
  • The Unregister Webhook method:
    • had the webhook_id parameter renamed to id.
    • had the required scope changed to webhooks.configuration:rw.
    • has a new mandatory parameter, owner_client_id.
  • The List Registered Webhooks method:
    • was renamed to List Webhooks.
    • had the required scope changed to webhooks.configuration:rw.
    • has a new mandatory parameter, owner_client_id.
    • 💡 You cannot list webhooks registered in older versions (v3.2 and below) with this method; first, you need to migrate them to v3.3.
  • The Register Webhook method:
    • had the webhook_id field in response renamed to id.
    • had the required scope changed to webhooks.configuration:rw.
    • has two new mandatory parameters: owner_client_id and type ("bot" or "license").
  • There are new methods for managing webhooks:
    • Enable License Webhooks
    • Disable License Webhooks
    • Get License Webhooks State
• The chat_member_ids filter was replaced by the chat_presence filter.
• There's new additional data, chat_presence_user_ids, available for the same webhooks that support the chat_properties additional data.

[v3.2] - 2020-06-18

Agents

• There are new methods for managing Agents:
  • Create Agent
  • Get Agent
  • List Agents
  • Update Agent
  • Delete Agent
  • Suspend Agent
  • Unsuspend Agent
  • Request Agent Unsuspension
  • Approve Agent

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:
  • Get Bot Agent Details -> Get Bot
  • Get Bot Agents -> List Bots
  • Create Bot Agent -> Create Bot
  • Remove Bot Agent -> Delete Bot

Groups

• There are new methods for managing Groups:
  • Create Group
  • Update Group
  • Delete Group
  • List Groups
  • Get Group

Properties

• It's possible to define properties in new locations: license and group.
• Method renames include:
  • Get Property Configs -> List Registered Properties
  • Create Properties -> Register Properties
• There are new methods:
  • Update License Properties
  • List License Properties
  • Delete License Properties
  • Update Group Properties
  • List Group Properties
  • Delete Group Properties

Webhooks

• There's a new field, license_id, in all webhooks.
• The agent_ids filter was added to the agent_deleted webhook.
• The agent_status_changed webhook was replaced with routing_status_set.
• The access_granted webhook was renamed to chat_access_granted. It no longer includes the resource parameter.
• The access_revoked webhook was renamed to chat_access_revoked. It no longer includes the resource parameter.
• Other method and webhook renames include:
  • Get Webhooks Config -> List Registered Webhooks
  • chat_thread_properties_updated -> thread_properties_updated
  • chat_thread_properties_deleted -> thread_properties_deleted
  • thread_closed -> chat_deactivated
  • incoming_chat_thread -> incoming_chat
  • chat_thread_tagged -> thread_tagged
  • chat_thread_untagged -> thread_untagged
  • chat_user_added -> user_added_to_chat
  • chat_user_removed -> user_removed_from_chat
• The agent_status_changed webhook was removed.
• The chat_access_set webhook was removed.

[v3.1] - 2019-09-17

Changed

• The data field in webhooks was renamed to payload.