GraphQL API Changelog – Overview: Jan 1 to May 29

This update includes several enhancements and simplifications to improve the efficiency and usability of our API. Please review the changes, especially if they affect areas you are using, to ensure a smooth transition.

👉 You can explore these updates in more detail directly in our GraphQL Page

New

  • Enum value: Added document to InterfacePageElementType.
  • Mutation: Added addTagsToResource to manage resource tagging.
  • Mutation: Added phaseSettings to configure phase settings.
  • Mutation: Added setFavoritePipes to manage favorite pipes.
  • Query: Added agentsUsageDetails to provide details on agent usage.
  • Query: Added automation for retrieving automation details.
  • Query: Added automationActions to list automation actions.
  • Query: Added automationEvents for event management within automations.
  • Query: Added automationEventsByPhase for phased automation events.
  • Query: Added automations to handle multiple automation tasks.
  • Query: Added automationsUsageDetails to provide usage statistics for automations.
  • Query: Added field for field data retrieval.
  • Query: Added organizationSettings for accessing organization settings.
  • Query: Added tagsByCategory to categorize tags.
  • Query: Added tagsByCategoryOnResource to manage tags by category on resources.
  • Query: Added ticket for ticket management.
  • Query: Added troubleshootLlmError for troubleshooting errors.
  • Field: Added overridePreviousWithSameUrl as a Boolean input to CreateWebhookInput.
  • Field: Added url to FieldCondition.
  • Field: Added preferences to Organization and OrganizationInterface for user preferences management.
  • Field: Added canBeTagged to ConnectedTable, Pipe, Repo, Table to manage tag availability.
  • Field: Added tags to Table for tagging functionality.
  • Field: Added billable, canBeRemoved, and openNestedStartForm to InterfacesMember and User for user management.
  • Type Added: Expanded schema with new types such as ActiveProvider, AddTagsResourceInput, AddTagsResourcePayload, AgentsDetails, AiAutomationSuggestion, AiProvider, AiProviders, Automation, and many more.

Deprecated

No items have been deprecated in this update.

Removed

  • Type: OrganizationPermissionsInternalGQL has been completely removed.

Changed

  • Field Update: Organization.permissions changed from OrganizationPermissionsInternalGQL to OrganizationPermissions.
  • Field Update: OrganizationInterface.permissions changed from OrganizationPermissionsInternalGQL to OrganizationPermissions.
  • Field Update: OrganizationMember.groups changed from GroupConnection to BasicGroupConnection.