Changelog

New Endpoints

Vistas

• /vistas.delete: Deletes a vista
• /vistas.get: Gets a vista’s information
• /vistas.list: Lists available vistas

Vista Group Items

• /vistas.groups.delete: Deletes a vista group item
• /vistas.groups.get: Gets a vista group item’s information
• /vistas.groups.list: Lists the available vista group items

Updated Endpoints

Webhooks

• Added webhook types for articles:
  • article_created
  • article_updated
  • article_deleted

New Endpoints

Chats

• /chats.update: Updates a chat (DM)

Record Templates

• /record-templates.get: Gets a record template’s information

Service Accounts

• /service-accounts.update: Updates a service account’s information

Subscribers

• /subscribers.list: Lists subscribers for an object

Surveys

• /surveys.get: Gets the information for a survey

Modified Endpoints

Accounts

• Adds primary_account field, which is set when the account is merged with another

AI Agents

• Adds suggestions agent response type to the ai_agent_response webhook event

Rev Orgs

• Adds primary_rev_org field, which is set when the Rev org (workspace) is merged with another

Users

• Adds primary_identity field, which is set when the user is merged with another

New Endpoints

Artifacts

• /artifacts.versions.delete: Delete an artifact version

Brands

• /brands.create: Create a new brand
• /brands.delete: Delete an existing brand
• /brands.get: Get the information for a brand
• /brands.list: List brands matching a given filter
• /brands.update: Update an existing brand

Links

• /links.replace: Replace a link

Metrics

• /metric-trackers.get: Get a metric tracker

Modified Endpoints

Accounts

• Added subtype and tier query parameters to /accounts.export and /accounts.list
• Added drop property to custom_schema_spec in /accounts.create and /accounts.update

Articles

• Added content_format and data_sources properties in /articles.create and /articles.update
• Made applies_to_parts optional in /articles.create

Commands

• Added ai_assistant_chat and dm to allowed object types in surface configuration for /commands.create, /commands.update and related endpoints

Conversations

• Added state query parameter to /conversations.list and /conversations.export
• Modified owned_by.set to allow empty arrays in /conversations.update

Groups

• Added filtering by created_by, name, and sync_metadata fields to /groups.list

Links

• Added custom_link_type property to link objects in /links.create and related endpoints

Meetings

• Added sync_metadata property to meeting objects in /meetings.create and related endpoints

Opportunities

• Added contacts property to opportunity objects in work-related endpoints

SLAs

• Added subtype and tier properties to account selector in /slas.create and /slas.update

Webhooks

• Added sla_tracker_fetched event type to /webhooks.create, /webhooks.update and related endpoints

Widgets

• Added combination visualization type
• Removed percentage_precision from PVP metric configuration

Schema Changes

Custom Schema Spec

Added drop property to custom_schema_spec in multiple endpoints including:

• Account endpoints
• Article endpoints
• Chat endpoints
• Code change endpoints
• Conversation endpoints
• Custom object endpoints
• Dev user endpoints
• Incident endpoints
• Meeting endpoints
• Part endpoints
• Work endpoints

Meeting Summary

Added new subschema to meeting summary objects affecting multiple endpoints that reference meetings

Link Summary

Modified link summary schema to support custom link types across multiple endpoints

New Endpoints

Service Accounts

• Added POST /service-accounts.create for creating service accounts

Widgets

• Added GET /widgets.get for retrieving widgets

Modified Features

Customization

• Added is_overridable property to schema enum fields

Timeline

• Added references property to timeline comments

Parts

• Added support for part types linkable and runnable

API Changelog

Modified Endpoints

SLAs

Added field in_policy to SLA metric target to indicate whether the metric is in the active SLA policy

Webhooks

New event types added to webhook related endpoints:

• dashboard_created
• dashboard_deleted
• dashboard_updated
• widget_created
• widget_deleted
• widget_updated

Dev Users

• Added new endpoint /dev-users.merge for merging Dev users

Groups

• Added member_rev_org property to member objects returned by:
  • /groups.members.list (both GET and POST methods)

Parts

• Added stage_validation_options property to request body of:
  • /parts.create
  • /parts.update
• Added custom_fields parameter to:
  • /parts.list (both GET and POST methods)

Question Answers

• Added sources property to question-answer object

API Changelog

New Endpoints

SLAs

• Added POST /sla-trackers.remove-metric for removing SLA metrics from objects.

Modified Endpoints

Rev users

• Endpoints POST /rev-users.link and POST /rev-users.unlink are deprecated and will be removed from future versions.

API Changelog

New Endpoints

Chats

• Added base chat object and subtype dm (direct message) and related endpoints.
  • POST /chats.create for creating a new chat.
  • GET /chats.get and POST /chats.get for fetching a chat by ID.

Snap-kits

• Added GET /snap-kit-action.execute.deferred for executing a deferred snap-kit action.

Surveys

• Added GET /surveys.responses.list and POST /surveys.responses.list for listing survey responses.

Modified Endpoints

Various

• Added property sync_metadata to various objects for reporting sync status
  • article
  • chat
  • conversation
  • custom_object
  • directory
  • group
  • incident
  • operation
  • part
  • role
  • timeline_entry
  • work

New Endpoints

AI Agents

• Added POST /ai-agents.events.execute-async for executing an AI agent input event asynchronously

Customization

• Added POST /schemas.subtypes.prepare-update for preparing a subtype change

Dev organizations

• Added GET /dev-orgs.get and POST /dev-orgs.get to fetch the authenticated user’s Dev organization information

Dev users

• Added POST /dev-users.create to create new Dev users

Rev users

• Added POST /rev-users.associations.add to add new associations (workspaces/Rev organizations and accounts) to Rev users
• Added POST /rev-users.associations.remove to remove associations from Rev users

Roles

• Added POST /roles.apply to add/remove roles of a principal

Webhooks

• Added POST /webhooks.event as an exposition endpoint for what webhook handlers must support

Modified Endpoints

Parts

• Added new properties to enhancement objects:
  • actual_close_date
  • actual_start_date
  • target_close_date
  • target_start_date

Rev users

• Added properties to rev-users.create and rev-users.update:
  • display_picture
  • external_refs

Search

• Added search namespaces:
  • account
  • capability
  • component
  • custom_object
  • custom_part
  • custom_work
  • dashboard
  • dev_user
  • enhancement
  • feature
  • group
  • linkable
  • microservice
  • object_member
  • opportunity
  • product
  • project
  • rev_org
  • rev_user
  • runnable
  • service_account
  • sys_user
  • tag
  • task
  • vista

Snap widgets

• Added new widget type starter_message_nudge to snap-widget objects

Timeline entries

• Added new property sync_metadata to timeline-entry objects

Work

• Added new property priority_v2 to issue objects
• Added new properties to ticket objects:
  • account
  • channels_v2
  • source_channel_v2
  • visibility

Webhook Events

• Added webhook event types:
  • question_answer_created
  • question_answer_deleted
  • question_answer_updated
• Added property reactions to timeline_entry_updated events

New Endpoints

Atoms

• Added GET /atoms.get and POST /atoms.get endpoints as a way to retrieve generic object information

Stage Diagrams

• Added new endpoints for managing stage diagrams:
  • POST /stage-diagrams.create
  • GET /stage-diagrams.get and POST /stage-diagrams.get
  • GET /stage-diagrams.list and POST /stage-diagrams.list
  • POST /stage-diagrams.update

Modified Endpoints

Conversations

• Added support for date filtering in conversations endpoints:

  • GET /conversations.list
  • POST /conversations.list
  • GET /conversations.export
  • POST /conversations.export

• Added new properties to conversation objects:

  • custom_fields
  • custom_schema_fragments
  • stock_schema_fragment
  • subtype

Incidents

• Added custom_fields support to incidents endpoints:
  • GET /incidents.group
  • POST /incidents.group
  • GET /incidents.list
  • POST /incidents.list

Snap-ins

• Added is_expired property to keyring objects in GET /snap-ins.resources and POST /snap-ins.resources responses

Schema Changes

The following schema changes affect multiple endpoints:

• Added translated_values property to enum field descriptors
• Added translated_values property to enum list field descriptors
• These changes affect endpoints that work with schemas, including:
  • Content template endpoints
  • Schema management endpoints
  • Survey endpoints
  • Timeline entry endpoints
  • Webhook event endpoints

Webhook Events

• Added old_conversation property to conversation delete/update events
• Added old_sla_tracker property to SLA tracker update events