OpsIQ Developer Documentation

Build on OpsIQ with the public action API, widget identity, webhooks, connector SDK, action gateway, and OpenAPI contract. These docs are customer-facing and apply to both hosted and self-hosted OpsIQ installs without exposing internal control-plane details.

Action API v1 stable 1525 named actions OpenAPI 3.0 + Postman 62 bearer scopes Connector Contract 2.2
No API docs matched. Try an action such as tickets.open, a scope like crm.write, or concepts like webhook signature, widget identity, Connector SDK, or error codes.

Start Here

OpsIQ exposes a stable namespaced action API at /api/v1.php. Send {"action":"meta.actions"} to discover the live catalog, then call actions such as crm.contacts.list, tickets.open, writing.reply, crm.deals.list, or kb.faq.save.

OpenAPI contract

The generated OpenAPI 3.0 document is available at /api/v1/openapi.php. Import it into Insomnia, Stoplight, an SDK generator, or another OpenAPI-aware client.

curl /api/v1/openapi.php

Postman collection

The generated Postman collection contains every named action with its scopes, request fields and examples: /api/v1/postman.php.

curl /api/v1/postman.php

Base URL

Use your own OpsIQ domain as the host. The path stays the same across installs.

https://your-opsiq-domain.com/api/v1.php

Coverage

1525 named actions: 564 reads and 961 writes across 62 scopes.

Every registered administrator JSON operation has a stable named action. Browser redirects, streams and file downloads remain on their purpose-built endpoints.

Every write operation should be tied to an API key scope and should pass through OpsIQ services or the connector gateway. Do not write directly to platform tables from custom code.

Authentication

Create an API key in OpsIQ, assign only the scopes that integration needs, and send it as a bearer token.

Authorization: Bearer opq_your_key_here
curl -X POST https://your-opsiq-domain.com/api/v1.php \
  -H "Authorization: Bearer opq_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"action":"meta.actions"}'

Keys can be rotated at any time. Store them server-side only. Browser widgets should use the widget identity token flow, not public API keys.

Every API v1 response includes a request_id. Keep it with integration logs so OpsIQ support can trace the exact authenticated request, workspace, action, outcome, and latency without storing the caller's raw IP address.

POST /api/v1.php
{"action":"meta.me"}

meta.me returns the verified key name, scopes, permissions mode, workspace, effective allowed/blocked actions, and recent usage summary for agency and enterprise integrations.

Scopes

ScopeAllowsTypical user
admin 1454 actions: 534 read, 920 write. Grant only when the integration needs this product surface.
administration.read 7 actions: 7 read, 0 write. Grant only when the integration needs this product surface.
administration.write 16 actions: 0 read, 16 write. Grant only when the integration needs this product surface.
analytics.read 32 actions: 32 read, 0 write. Grant only when the integration needs this product surface.
analytics.write 21 actions: 0 read, 21 write. Grant only when the integration needs this product surface.
automations.read 4 actions: 4 read, 0 write. Grant only when the integration needs this product surface.
automations.write 2 actions: 0 read, 2 write. Grant only when the integration needs this product surface.
chat.read 2 actions: 2 read, 0 write. Grant only when the integration needs this product surface.
chat.write 27 actions: 0 read, 27 write. Grant only when the integration needs this product surface.
communications.read 9 actions: 9 read, 0 write. Grant only when the integration needs this product surface.
communications.write 12 actions: 0 read, 12 write. Grant only when the integration needs this product surface.
connector_builder.read 6 actions: 6 read, 0 write. Grant only when the integration needs this product surface.
connector_builder.write 6 actions: 0 read, 6 write. Grant only when the integration needs this product surface.
connectors.read 23 actions: 23 read, 0 write. Grant only when the integration needs this product surface.
connectors.write 27 actions: 0 read, 27 write. Grant only when the integration needs this product surface.
conversations.read 3 actions: 3 read, 0 write. Grant only when the integration needs this product surface.
conversations.write 35 actions: 0 read, 35 write. Grant only when the integration needs this product surface.
crm.read 102 actions: 102 read, 0 write. Grant only when the integration needs this product surface.
crm.write 107 actions: 0 read, 107 write. Grant only when the integration needs this product surface.
customers.read 8 actions: 8 read, 0 write. Grant only when the integration needs this product surface.
customers.write 36 actions: 0 read, 36 write. Grant only when the integration needs this product surface.
departments.read 1 action: 1 read, 0 write. Grant only when the integration needs this product surface.
engagement.read 68 actions: 68 read, 0 write. Grant only when the integration needs this product surface.
engagement.write 73 actions: 0 read, 73 write. Grant only when the integration needs this product surface.
feedback.read 6 actions: 6 read, 0 write. Grant only when the integration needs this product surface.
feedback.write 2 actions: 0 read, 2 write. Grant only when the integration needs this product surface.
files.read 1 action: 1 read, 0 write. Grant only when the integration needs this product surface.
intent.read 5 actions: 5 read, 0 write. Grant only when the integration needs this product surface.
intent.write 1 action: 0 read, 1 write. Grant only when the integration needs this product surface.
journey.read 1 action: 1 read, 0 write. Grant only when the integration needs this product surface.
journey.write 1 action: 0 read, 1 write. Grant only when the integration needs this product surface.
kb.read 21 actions: 21 read, 0 write. Grant only when the integration needs this product surface.
kb.write 57 actions: 0 read, 57 write. Grant only when the integration needs this product surface.
leads.read 3 actions: 3 read, 0 write. Grant only when the integration needs this product surface.
leads.write 3 actions: 0 read, 3 write. Grant only when the integration needs this product surface.
notifications.read 1 action: 1 read, 0 write. Grant only when the integration needs this product surface.
platform.read 137 actions: 137 read, 0 write. Grant only when the integration needs this product surface.
platform.write 171 actions: 0 read, 171 write. Grant only when the integration needs this product surface.
portal_studio.read 35 actions: 35 read, 0 write. Grant only when the integration needs this product surface.
portal_studio.write 52 actions: 0 read, 52 write. Grant only when the integration needs this product surface.
read 1 action: 1 read, 0 write. Grant only when the integration needs this product surface.
sales.read 8 actions: 8 read, 0 write. Grant only when the integration needs this product surface.
sales.write 6 actions: 0 read, 6 write. Grant only when the integration needs this product surface.
security.read 11 actions: 11 read, 0 write. Grant only when the integration needs this product surface.
security.write 10 actions: 0 read, 10 write. Grant only when the integration needs this product surface.
sessions.read 5 actions: 5 read, 0 write. Grant only when the integration needs this product surface.
settings.read 3 actions: 3 read, 0 write. Grant only when the integration needs this product surface.
settings.write 8 actions: 0 read, 8 write. Grant only when the integration needs this product surface.
site_intelligence.read 28 actions: 28 read, 0 write. Grant only when the integration needs this product surface.
site_intelligence.write 192 actions: 0 read, 192 write. Grant only when the integration needs this product surface.
status.read 1 action: 1 read, 0 write. Grant only when the integration needs this product surface.
status.write 5 actions: 0 read, 5 write. Grant only when the integration needs this product surface.
surveys.read 13 actions: 13 read, 0 write. Grant only when the integration needs this product surface.
surveys.write 9 actions: 0 read, 9 write. Grant only when the integration needs this product surface.
team.read 2 actions: 2 read, 0 write. Grant only when the integration needs this product surface.
team.write 26 actions: 0 read, 26 write. Grant only when the integration needs this product surface.
tickets.read 24 actions: 24 read, 0 write. Grant only when the integration needs this product surface.
tickets.write 51 actions: 0 read, 51 write. Grant only when the integration needs this product surface.
todos.write 1 action: 0 read, 1 write. Grant only when the integration needs this product surface.
visitors.read 2 actions: 2 read, 0 write. Grant only when the integration needs this product surface.
visitors.write 1 action: 0 read, 1 write. Grant only when the integration needs this product surface.
writing 6 actions: 0 read, 6 write. Grant only when the integration needs this product surface.

Complete action directory

This directory is generated from the same canonical contract used by meta.actions, request validation, API-key scope selection and the OpenAPI document. It therefore stays aligned with the running code instead of maintaining a separate hand-written action list.

1525 named actions are published across 62 scopes: 564 reads and 961 writes. For a field-level contract, call meta.action, import OpenAPI, or download the Postman collection.

Contract quality: compatibility 30  declared_dynamic 346  explicit 86  route_inferred 970  source_inferred 93 

administration — 23 actions
ActionKindScopePlan featureContractRequired fieldsSummary
administration.2fa.disable WRITE administration.write, admin Any plan route_inferred None Admin 2fa Disable
administration.2fa.enable WRITE administration.write, admin Any plan route_inferred None Admin 2fa Enable
administration.2fa.recovery.regenerate WRITE administration.write, admin Any plan route_inferred None Admin 2fa Recovery Regenerate
administration.2fa.setup READ administration.read, admin Any plan declared_dynamic None Admin 2fa Setup
administration.2fa.status READ administration.read, admin Any plan declared_dynamic None Admin 2fa Status
administration.ai.train.from.reply WRITE administration.write, admin admin_chat route_inferred None Admin Ai Train From Reply
administration.brain.cancel WRITE administration.write, admin Any plan declared_dynamic None Admin Brain Cancel
administration.chat.access.check WRITE administration.write, admin Any plan route_inferred None Admin Chat Access Check
administration.chat.create.ticket.on.behalf WRITE administration.write, admin Any plan route_inferred None Admin Chat Create Ticket On Behalf
administration.chat.draft.ticket.from.thread WRITE administration.write, admin Any plan route_inferred None Admin Chat Draft Ticket From Thread
administration.conv.delete WRITE administration.write, admin Any plan route_inferred None Admin Conv Delete
administration.conv.get WRITE administration.write, admin Any plan route_inferred None Admin Conv Get
administration.conv.list WRITE administration.write, admin Any plan route_inferred None Admin Conv List
administration.conv.new WRITE administration.write, admin Any plan route_inferred None Admin Conv New
administration.conv.save WRITE administration.write, admin Any plan route_inferred None Admin Conv Save
administration.notification.prefs.get READ administration.read, admin Any plan declared_dynamic None Admin Notification Prefs Get
administration.notification.prefs.save WRITE administration.write, admin Any plan declared_dynamic None Admin Notification Prefs Save
administration.notifications.list READ administration.read, admin Any plan route_inferred None Admin Notifications List
administration.notifications.mark.all.read READ administration.read, admin Any plan declared_dynamic None Admin Notifications Mark All Read
administration.notifications.mark.read READ administration.read, admin Any plan route_inferred None Admin Notifications Mark Read
administration.notifications.pulse WRITE administration.write, admin Any plan route_inferred None Admin Notifications Pulse
administration.online.list READ administration.read, admin Any plan declared_dynamic None Admin Online List
administration.presence.ping WRITE administration.write, admin Any plan declared_dynamic None Admin Presence Ping
analytics — 43 actions
ActionKindScopePlan featureContractRequired fieldsSummary
analytics.add.widget WRITE analytics.write, admin analytics route_inferred None Dashboard Add Widget
analytics.analytics.connectors.catalog READ analytics.read, admin analytics declared_dynamic None Analytics Connectors Catalog
analytics.analytics.data READ analytics.read, admin analytics route_inferred None Analytics Data
analytics.analytics.export READ analytics.read, admin analytics route_inferred None Analytics Export
analytics.analytics.export.csv READ analytics.read, admin analytics route_inferred None Analytics Export Csv
analytics.analytics.import WRITE analytics.write, admin analytics route_inferred None Analytics Import
analytics.analytics.report WRITE analytics.write, admin analytics route_inferred None Analytics Report
analytics.analytics.segments.delete WRITE analytics.write, admin analytics route_inferred None Analytics Segments Delete
analytics.analytics.segments.list READ analytics.read, admin analytics declared_dynamic None Analytics Segments List
analytics.analytics.segments.save WRITE analytics.write, admin analytics route_inferred None Analytics Segments Save
analytics.analytics.status READ analytics.read, admin analytics declared_dynamic None Analytics Status
analytics.clear.all WRITE analytics.write, admin analytics declared_dynamic None Replay Clear All
analytics.compute READ analytics.read, admin analytics route_inferred None Funnels Compute
analytics.create WRITE analytics.write, admin analytics route_inferred None Ab Test Create
analytics.create.route.dashboard.create WRITE analytics.write, admin analytics route_inferred None Dashboard Create
analytics.create.route.report.create WRITE analytics.write, admin analytics route_inferred None Report Create
analytics.delete WRITE analytics.write, admin analytics route_inferred None Ab Test Delete
analytics.delete.route.dashboard.delete WRITE analytics.write, admin analytics route_inferred None Dashboard Delete
analytics.delete.route.funnels.delete WRITE analytics.write, admin analytics route_inferred None Funnels Delete
analytics.delete.route.report.delete WRITE analytics.write, admin analytics route_inferred None Report Delete
analytics.events READ analytics.read, admin analytics route_inferred None Replay Events
analytics.export READ analytics.read, admin analytics source_inferred None Analytics Export
analytics.get READ analytics.read, admin analytics route_inferred None Dashboard Get
analytics.layout.get READ analytics.read, admin analytics declared_dynamic None Dashboard Layout Get
analytics.layout.save WRITE analytics.write, admin analytics route_inferred None Dashboard Layout Save
analytics.list READ analytics.read, admin analytics declared_dynamic None Ab Test List
analytics.list.route.dashboard.list READ analytics.read, admin analytics declared_dynamic None Dashboard List
analytics.list.route.funnels.list READ analytics.read, admin analytics declared_dynamic None Funnels List
analytics.list.route.report.list READ analytics.read, admin analytics declared_dynamic None Report List
analytics.remove.widget WRITE analytics.write, admin analytics route_inferred None Dashboard Remove Widget
analytics.rename READ analytics.read, admin analytics route_inferred None Dashboard Rename
analytics.results READ analytics.read, admin analytics route_inferred None Ab Test Results
analytics.save WRITE analytics.write, admin analytics route_inferred None Funnels Save
analytics.scheduled.list READ analytics.read, admin analytics explicit admin_id List scheduled analytics reports for an operator
analytics.sections.list READ analytics.read, admin analytics explicit None List analytics report sections and date presets
analytics.send.now WRITE analytics.write, admin analytics route_inferred None Report Send Now
analytics.sessions READ analytics.read, admin analytics route_inferred None Replay Sessions
analytics.step.visitors READ analytics.read, admin analytics route_inferred None Funnels Step Visitors
analytics.timeline READ analytics.read, admin analytics route_inferred None Replay Timeline
analytics.toggle.shared WRITE analytics.write, admin analytics route_inferred None Dashboard Toggle Shared
analytics.update WRITE analytics.write, admin analytics route_inferred None Ab Test Update
analytics.update.route.report.update WRITE analytics.write, admin analytics route_inferred None Report Update
analytics.widget.data READ analytics.read, admin analytics route_inferred None Dashboard Widget Data
automations — 6 actions
ActionKindScopePlan featureContractRequired fieldsSummary
automations.actions.list READ automations.read, admin actions_triggers explicit None List integration actions
automations.delete WRITE automations.write, admin crm_automation route_inferred None Workflow Delete
automations.list READ automations.read, admin crm_automation route_inferred None Workflow List
automations.runs.list READ automations.read, admin actions_triggers explicit None List automation execution history
automations.save WRITE automations.write, admin crm_automation route_inferred None Workflow Save
automations.triggers.list READ automations.read, admin actions_triggers explicit None List integration triggers
chat — 29 actions
ActionKindScopePlan featureContractRequired fieldsSummary
chat.call.start WRITE chat.write, admin Any plan route_inferred None Chat Call Start
chat.cobrowse.send WRITE chat.write, admin Any plan route_inferred None Chat Cobrowse Send
chat.feedback READ chat.read, admin Any plan route_inferred None Chat Feedback
chat.feedback.digest WRITE chat.write, admin Any plan route_inferred None Chat Feedback Digest
chat.online.admins WRITE chat.write, admin Any plan route_inferred None Chat Online Admins
chat.permissions.list WRITE chat.write, admin Any plan declared_dynamic None Chat Permissions List
chat.permissions.revoke WRITE chat.write, admin Any plan route_inferred None Chat Permissions Revoke
chat.permissions.save WRITE chat.write, admin Any plan route_inferred None Chat Permissions Save
chat.permissions.upload.avatar WRITE chat.write, admin Any plan route_inferred None Chat Permissions Upload Avatar
chat.reaction.toggle WRITE chat.write, admin Any plan route_inferred None Chat Reaction Toggle
chat.saved_replies.add WRITE chat.write, admin client_chat source_inferred None Chat Saved Replies Add
chat.saved_replies.list READ chat.read, admin client_chat explicit None List workspace and personal saved replies
chat.saved_replies.save WRITE chat.write, admin client_chat source_inferred None Chat Saved Replies Save
chat.set.persona WRITE chat.write, admin Any plan route_inferred None Chat Set Persona
chat.snooze.clear WRITE chat.write, admin Any plan route_inferred None Chat Snooze Clear
chat.snooze.set WRITE chat.write, admin Any plan route_inferred None Chat Snooze Set
chat.transfer.thread WRITE chat.write, admin Any plan route_inferred None Chat Transfer Thread
chat.transfer.unread WRITE chat.write, admin Any plan declared_dynamic None Chat Transfer Unread
chat.typing.preview WRITE chat.write, admin Any plan route_inferred None Chat Typing Preview
chat.whisper.ai.summary WRITE chat.write, admin Any plan route_inferred None Chat Whisper Ai Summary
chat.whisper.controls WRITE chat.write, admin Any plan declared_dynamic None Chat Whisper Controls
chat.whisper.delete.room WRITE chat.write, admin Any plan route_inferred None Chat Whisper Delete Room
chat.whisper.list WRITE chat.write, admin Any plan route_inferred None Chat Whisper List
chat.whisper.mentions WRITE chat.write, admin Any plan declared_dynamic None Chat Whisper Mentions
chat.whisper.rooms WRITE chat.write, admin Any plan declared_dynamic None Chat Whisper Rooms
chat.whisper.save.controls WRITE chat.write, admin Any plan route_inferred None Chat Whisper Save Controls
chat.whisper.send WRITE chat.write, admin Any plan route_inferred None Chat Whisper Send
chat.whisper.targets WRITE chat.write, admin Any plan declared_dynamic None Chat Whisper Targets
chat.whisper.unread WRITE chat.write, admin Any plan route_inferred None Chat Whisper Unread
communications — 21 actions
ActionKindScopePlan featureContractRequired fieldsSummary
communications.auth.check READ communications.read, admin Any plan route_inferred None Email Auth Check
communications.campaign.delete WRITE communications.write, admin proactive_engagement route_inferred None Push Campaign Delete
communications.campaign.save WRITE communications.write, admin proactive_engagement route_inferred None Push Campaign Save
communications.campaign.send WRITE communications.write, admin proactive_engagement route_inferred None Push Campaign Send
communications.campaigns.list READ communications.read, admin proactive_engagement declared_dynamic None Push Campaigns List
communications.drafts.delete WRITE communications.write, admin email_drafts route_inferred None Email Drafts Delete
communications.drafts.list READ communications.read, admin email_drafts declared_dynamic None Email Drafts List
communications.drafts.save WRITE communications.write, admin email_drafts route_inferred None Email Drafts Save
communications.drafts.send WRITE communications.write, admin email_drafts route_inferred None Email Drafts Send
communications.mailboxes.delete WRITE communications.write, admin email_mailboxes route_inferred None Email Mailboxes Delete
communications.mailboxes.list READ communications.read, admin email_mailboxes route_inferred None Email Mailboxes List
communications.mailboxes.poll READ communications.read, admin email_mailboxes declared_dynamic None Email Mailboxes Poll
communications.mailboxes.save WRITE communications.write, admin email_mailboxes declared_dynamic None Email Mailboxes Save
communications.mailboxes.test READ communications.read, admin email_mailboxes declared_dynamic None Email Mailboxes Test
communications.pipe.regen.token WRITE communications.write, admin Any plan declared_dynamic None Email Pipe Regen Token
communications.platform.list READ communications.read, admin email_mailboxes declared_dynamic None Email Platform List
communications.platform.send WRITE communications.write, admin email_mailboxes route_inferred None Email Platform Send
communications.settings.get READ communications.read, admin email_mailboxes declared_dynamic None Email Settings Get
communications.settings.save WRITE communications.write, admin email_mailboxes route_inferred None Email Settings Save
communications.settings.test READ communications.read, admin email_mailboxes route_inferred None Email Settings Test
communications.vapid.generate WRITE communications.write, admin Any plan declared_dynamic None Push Vapid Generate
connector_builder — 11 actions
ActionKindScopePlan featureContractRequired fieldsSummary
connector_builder.export READ connector_builder.read, admin connectors explicit slug Export a generated connector
connector_builder.generate WRITE connector_builder.write, admin connectors explicit spec Generate a connector package
connector_builder.get READ connector_builder.read, admin connectors explicit slug Load a Builder specification
connector_builder.import.curl WRITE connector_builder.write, admin connectors explicit None Import cURL into Connector Builder
connector_builder.import.openapi WRITE connector_builder.write, admin connectors explicit None Import OpenAPI into Connector Builder
connector_builder.import.postman WRITE connector_builder.write, admin connectors explicit None Import Postman into Connector Builder
connector_builder.list READ connector_builder.read, admin connectors explicit None List Builder connectors
connector_builder.profiles READ connector_builder.read, connectors.read, admin Any plan explicit None List Connector Builder profiles and capability contracts
connector_builder.test WRITE connector_builder.write, admin connectors explicit slug Run Builder conformance tests
connector_builder.update WRITE connector_builder.write, admin connectors explicit slug, spec Update a generated connector
connector_builder.validate READ connector_builder.read, admin connectors explicit spec Validate a Builder specification
connectors — 49 actions
ActionKindScopePlan featureContractRequired fieldsSummary
connectors.action WRITE connectors.write, admin connectors route_inferred None Connectors Action
connectors.backfill WRITE connectors.write, admin connectors explicit slug Start connector backfill
connectors.backfill.route.connectors.backfill WRITE connectors.write, admin connectors route_inferred None Connectors Backfill
connectors.backfill.status READ connectors.read, admin connectors explicit slug Read connector backfill status
connectors.backfill.status.route.connectors.backfill.status READ connectors.read, admin connectors route_inferred None Connectors Backfill Status
connectors.builder.ai.actions READ connectors.read, admin connectors route_inferred None Connectors Builder Ai Actions
connectors.builder.ai.handler READ connectors.read, admin connectors route_inferred None Connectors Builder Ai Handler
connectors.builder.ai.map WRITE connectors.write, admin connectors route_inferred None Connectors Builder Ai Map
connectors.builder.delete WRITE connectors.write, admin connectors route_inferred None Connectors Builder Delete
connectors.builder.dry.run WRITE connectors.write, admin connectors route_inferred None Connectors Builder Dry Run
connectors.builder.generate WRITE connectors.write, admin connectors route_inferred None Connectors Builder Generate
connectors.builder.import.curl WRITE connectors.write, admin connectors route_inferred None Connectors Builder Import Curl
connectors.builder.import.openapi WRITE connectors.write, admin connectors route_inferred None Connectors Builder Import Openapi
connectors.builder.import.postman WRITE connectors.write, admin connectors route_inferred None Connectors Builder Import Postman
connectors.builder.list READ connectors.read, admin connectors declared_dynamic None Connectors Builder List
connectors.builder.load READ connectors.read, admin connectors route_inferred None Connectors Builder Load
connectors.builder.marketplace.apply WRITE connectors.write, admin connectors route_inferred None Connectors Builder Marketplace Apply
connectors.builder.marketplace.link WRITE connectors.write, admin connectors route_inferred None Connectors Builder Marketplace Link
connectors.builder.marketplace.status READ connectors.read, admin connectors declared_dynamic None Connectors Builder Marketplace Status
connectors.builder.marketplace.submit WRITE connectors.write, admin connectors route_inferred None Connectors Builder Marketplace Submit
connectors.builder.test READ connectors.read, admin connectors route_inferred None Connectors Builder Test
connectors.builder.test.action READ connectors.read, admin connectors route_inferred None Connectors Builder Test Action
connectors.builder.update WRITE connectors.write, admin connectors route_inferred None Connectors Builder Update
connectors.builder.validate READ connectors.read, admin connectors route_inferred None Connectors Builder Validate
connectors.contacts.import WRITE connectors.write, admin connectors route_inferred None Connector Contacts Import
connectors.contract READ connectors.read, connector_builder.read, admin Any plan explicit None Read the canonical connector capability contract
connectors.customers.sync WRITE connectors.write, admin connectors explicit slug Synchronize connector customers
connectors.disable WRITE connectors.write, admin connectors explicit slug Disable a connector
connectors.disable.route.connectors.disable WRITE connectors.write, admin connectors route_inferred None Connectors Disable
connectors.email.account.department READ connectors.read, admin connectors route_inferred None Connector Email Account Department
connectors.email.account.remove WRITE connectors.write, admin connectors route_inferred None Connector Email Account Remove
connectors.email.account.routing READ connectors.read, admin connectors route_inferred None Connector Email Account Routing
connectors.enable WRITE connectors.write, admin connectors explicit slug Enable a connector
connectors.enable.route.connectors.enable WRITE connectors.write, admin connectors route_inferred None Connectors Enable
connectors.get READ connectors.read, admin connectors source_inferred None Connectors Get
connectors.get.route.connectors.get READ connectors.read, admin connectors route_inferred None Connectors Get
connectors.install WRITE connectors.write, admin connectors route_inferred None Connectors Install
connectors.integrity.scan READ connectors.read, admin connectors declared_dynamic None Connector Integrity Scan
connectors.list READ connectors.read, admin connectors explicit None List installed connectors and capabilities
connectors.list.route.connectors.list READ connectors.read, admin connectors declared_dynamic None Connectors List
connectors.oauth.start WRITE connectors.write, admin connectors route_inferred None Connector Oauth Start
connectors.settings.get READ connectors.read, admin connectors explicit slug Read connector settings
connectors.settings.save WRITE connectors.write, admin connectors explicit slug, settings Save connector settings
connectors.shared.oauth.delete WRITE connectors.write, admin connectors route_inferred None Connector Shared Oauth Delete
connectors.sync.customers WRITE connectors.write, admin connectors route_inferred None Connectors Sync Customers
connectors.test READ connectors.read, admin connectors source_inferred None Connectors Test
connectors.test.route.connectors.test READ connectors.read, admin connectors route_inferred None Connectors Test
connectors.uninstall WRITE connectors.write, admin connectors route_inferred None Connectors Uninstall
connectors.workflow.recipes READ connectors.read, admin connectors route_inferred None Connectors Workflow Recipes
conversations — 38 actions
ActionKindScopePlan featureContractRequired fieldsSummary
conversations.ai.draft WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Ai Draft
conversations.ai.rewrite WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Ai Rewrite
conversations.archive WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Archive
conversations.archive.messages WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Archive Messages
conversations.assign WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Assign
conversations.assignees WRITE conversations.write, admin client_chat declared_dynamic None Admin Client Chat Assignees
conversations.bulk WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Bulk
conversations.clear WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Clear
conversations.clear.all WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Clear All
conversations.customer.tickets WRITE conversations.write, admin client_chat declared_dynamic None Admin Client Chat Customer Tickets
conversations.decline WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Decline
conversations.delete WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Delete
conversations.delete.last WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Delete Last
conversations.edit.last WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Edit Last
conversations.export WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Export
conversations.forget.visitor WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Forget Visitor
conversations.get READ conversations.read, admin client_chat source_inferred None Conversations Get
conversations.list READ conversations.read, admin client_chat source_inferred None Conversations List
conversations.messages READ conversations.read, admin client_chat source_inferred None Conversations Messages
conversations.resolve WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Resolve
conversations.saved.replies WRITE conversations.write, admin client_chat declared_dynamic None Admin Client Chat Saved Replies
conversations.saved.reply.add WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Saved Reply Add
conversations.saved.reply.ai.generate WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Saved Reply Ai Generate
conversations.saved.reply.delete WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Saved Reply Delete
conversations.saved.reply.save WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Saved Reply Save
conversations.send WRITE conversations.write, admin client_chat source_inferred None Conversations Send
conversations.send.route.admin.client.chat.send WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Send
conversations.tags.set WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Tags Set
conversations.thread WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Thread
conversations.threads WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Threads
conversations.toggle WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Toggle
conversations.toggle.attachments WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Toggle Attachments
conversations.toggle.call.button WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Toggle Call Button
conversations.typing WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Typing
conversations.unarchive WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Unarchive
conversations.unarchive.messages WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Unarchive Messages
conversations.update WRITE conversations.write, admin client_chat explicit None Update a conversation status, assignment or subject
conversations.upload WRITE conversations.write, admin client_chat route_inferred None Admin Client Chat Upload
crm — 206 actions
ActionKindScopePlan featureContractRequired fieldsSummary
crm.ab.results READ crm.read, admin crm route_inferred None Crm Ab Results
crm.access.set WRITE crm.write, admin crm route_inferred None Crm Access Set
crm.access_log.list READ admin crm source_inferred None Crm Access Log List
crm.account.health READ crm.read, admin crm declared_dynamic None Crm Account Health
crm.account.health.board READ crm.read, admin crm declared_dynamic None Crm Account Health Board
crm.account.health.refresh WRITE crm.write, admin crm declared_dynamic None Crm Account Health Refresh
crm.account.timeline READ crm.read, admin crm route_inferred None Crm Account Timeline
crm.activities.list READ crm.read crm explicit None List CRM contact activities
crm.activities.record WRITE crm.write crm explicit contact_id, activity_type Record a CRM contact activity
crm.activity.feed READ crm.read, admin crm route_inferred None Crm Activity Feed
crm.ai.trace READ crm.read, admin crm route_inferred None Crm Ai Trace
crm.approval.decide WRITE crm.write, admin crm route_inferred None Crm Approval Decide
crm.approval.list READ crm.read, admin crm route_inferred None Crm Approval List
crm.approval.settings WRITE crm.write, admin crm route_inferred None Crm Approval Settings
crm.approve.apply WRITE crm.write, admin crm declared_dynamic None Crm Approve Apply
crm.approve.list READ crm.read, admin crm declared_dynamic None Crm Approve List
crm.approve.reject WRITE crm.write, admin crm declared_dynamic None Crm Approve Reject
crm.approve.update WRITE crm.write, admin crm declared_dynamic None Crm Approve Update
crm.ask WRITE crm.write, admin crm route_inferred None Crm Ask
crm.assign.owner WRITE crm.write, admin crm route_inferred None Contact Assign Owner
crm.assignment.get READ crm.read, admin crm declared_dynamic None Crm Assignment Get
crm.assignment.save WRITE crm.write, admin crm route_inferred None Crm Assignment Save
crm.attachment.delete WRITE crm.write, admin crm route_inferred None Crm Attachment Delete
crm.attachment.list READ crm.read, admin crm route_inferred None Crm Attachment List
crm.attachment.upload WRITE crm.write, admin crm route_inferred None Crm Attachment Upload
crm.autobook.meeting READ crm.read, admin crm route_inferred None Crm Autobook Meeting
crm.book.meeting READ crm.read, admin crm route_inferred None Crm Book Meeting
crm.booking.link.save WRITE crm.write, admin crm declared_dynamic None Crm Booking Link Save
crm.booking.links.list READ crm.read, admin crm declared_dynamic None Crm Booking Links List
crm.build.apply WRITE crm.write, admin crm declared_dynamic None Crm Build Apply
crm.build.get READ crm.read, admin crm declared_dynamic None Crm Build Get
crm.build.list READ crm.read, admin crm declared_dynamic None Crm Build List
crm.build.plan WRITE crm.write, admin crm declared_dynamic None Crm Build Plan
crm.build.rollback WRITE crm.write, admin crm declared_dynamic None Crm Build Rollback
crm.bulk WRITE crm.write, admin crm route_inferred None Contact Bulk
crm.calendar.status READ crm.read, admin crm declared_dynamic None Crm Calendar Status
crm.command.snapshot READ crm.read, admin crm declared_dynamic None Crm Command Snapshot
crm.companies.list READ crm.read, admin crm declared_dynamic None Crm Companies List
crm.company.hierarchy READ crm.read, admin crm route_inferred None Crm Company Hierarchy
crm.company.save WRITE crm.write, admin crm declared_dynamic None Crm Company Save
crm.company.set.parent WRITE crm.write, admin crm route_inferred None Crm Company Set Parent
crm.company.suggest.related READ crm.read, admin crm route_inferred None Crm Company Suggest Related
crm.connectors.catalog READ crm.read, admin crm declared_dynamic None Crm Connectors Catalog
crm.consent_log.list READ crm.read crm source_inferred None Crm Consent Log List
crm.contact.churn READ crm.read, admin crm route_inferred None Crm Contact Churn
crm.contact.draft.email WRITE crm.write, admin crm route_inferred None Crm Contact Draft Email
crm.contact.enrich WRITE crm.write, admin crm route_inferred None Crm Contact Enrich
crm.contact.propose.email READ crm.read, admin crm route_inferred None Crm Contact Propose Email
crm.contacts.detail READ crm.read crm source_inferred None Crm Contacts Detail
crm.contacts.erase WRITE admin crm source_inferred None Crm Contacts Erase
crm.contacts.export READ crm.read crm source_inferred None Crm Contacts Export
crm.contacts.import.list READ crm.read crm source_inferred None Crm Contacts Import List
crm.contacts.import.run WRITE crm.write crm source_inferred None Crm Contacts Import Run
crm.contacts.list READ crm.read crm source_inferred None Crm Contacts List
crm.contacts.next_action READ crm.read crm source_inferred None Crm Contacts Next Action
crm.contacts.open_chat WRITE crm.write crm source_inferred None Crm Contacts Open Chat
crm.contacts.open_ticket WRITE crm.write crm source_inferred None Crm Contacts Open Ticket
crm.contacts.resync WRITE crm.write crm source_inferred None Crm Contacts Resync
crm.contacts.save WRITE crm.write crm source_inferred None Crm Contacts Save
crm.contacts.send_email WRITE crm.write crm source_inferred None Crm Contacts Send Email
crm.contacts.upsert WRITE crm.write crm explicit email Crm Contacts Upsert
crm.conversation.intel READ crm.read, admin crm declared_dynamic None Crm Conversation Intel
crm.conversions.goals.delete WRITE crm.write crm_automation source_inferred None Crm Conversions Goals Delete
crm.conversions.goals.list READ crm.read crm_automation source_inferred None Crm Conversions Goals List
crm.conversions.goals.save WRITE crm.write crm_automation source_inferred None Crm Conversions Goals Save
crm.conversions.list READ crm.read crm source_inferred None Crm Conversions List
crm.conversions.record WRITE crm.write crm source_inferred None Crm Conversions Record
crm.create.video.meeting WRITE crm.write, admin crm route_inferred None Crm Create Video Meeting
crm.customer.auto.sync WRITE crm.write, admin crm route_inferred None Crm Customer Auto Sync
crm.customer.auto.sync.status READ crm.read, admin crm route_inferred None Crm Customer Auto Sync Status
crm.customer.emails READ crm.read, admin crm route_inferred None Crm Customer Emails
crm.customer.payments READ crm.read, admin crm route_inferred None Crm Customer Payments
crm.data.steward.bulk.propose READ crm.read, admin crm route_inferred None Crm Data Steward Bulk Propose
crm.data.steward.inbox READ crm.read, admin crm declared_dynamic None Crm Data Steward Inbox
crm.data.steward.propose READ crm.read, admin crm route_inferred None Crm Data Steward Propose
crm.deal.advance WRITE crm.write, admin crm route_inferred None Crm Deal Advance
crm.deal.coach READ crm.read, admin crm declared_dynamic None Crm Deal Coach
crm.deal.coach.action WRITE crm.write, admin crm declared_dynamic None Crm Deal Coach Action
crm.deal.get READ crm.read, admin crm declared_dynamic None Crm Deal Get
crm.deal.save WRITE crm.write, admin crm route_inferred None Crm Deal Save
crm.deals.advance WRITE crm.write crm explicit deal_id, stage_id Advance a CRM deal to another stage
crm.deals.create WRITE crm.write crm explicit title Create a CRM deal
crm.deals.detail READ crm.read crm explicit deal_id Get one CRM deal
crm.deals.list READ crm.read crm explicit None List CRM deals
crm.deals.list.route.crm.deals.list READ crm.read, admin crm declared_dynamic None Crm Deals List
crm.deals.update WRITE crm.write crm explicit deal_id Update a CRM deal
crm.detail WRITE crm.write, admin crm route_inferred None Contact Detail
crm.draft.outreach WRITE crm.write, admin crm declared_dynamic None Crm Draft Outreach
crm.enrich.account WRITE crm.write, admin crm route_inferred None Crm Enrich Account
crm.erase WRITE crm.write, admin crm route_inferred None Contact Erase
crm.events.catalog READ crm.read crm explicit None List subscribable CRM domain events
crm.events.list READ crm.read crm explicit None List durable CRM domain events
crm.export WRITE crm.write, admin crm route_inferred None Contact Export
crm.export.all READ crm.read, admin crm route_inferred None Contact Export All
crm.field.add WRITE crm.write, admin crm route_inferred None Crm Field Add
crm.field.remove WRITE crm.write, admin crm route_inferred None Crm Field Remove
crm.fields.list READ crm.read, admin crm declared_dynamic None Crm Fields List
crm.forecast.board READ crm.read, admin crm declared_dynamic None Crm Forecast Board
crm.forecast.snapshot WRITE crm.write, admin crm declared_dynamic None Crm Forecast Snapshot
crm.form.save WRITE crm.write, admin crm declared_dynamic None Crm Form Save
crm.forms.list READ crm.read, admin crm declared_dynamic None Crm Forms List
crm.health.repair.catalog READ crm.read, admin crm declared_dynamic None Crm Health Repair Catalog
crm.health.smoke READ crm.read, admin crm declared_dynamic None Crm Health Smoke
crm.health.snapshot READ crm.read, admin crm declared_dynamic None Crm Health Snapshot
crm.import.list READ crm.read, admin crm route_inferred None Contact Import List
crm.import.run WRITE crm.write, admin crm route_inferred None Contact Import Run
crm.inbound.activity READ crm.read webhooks source_inferred None Crm Inbound Activity
crm.inbound.endpoints.delete WRITE crm.write webhooks source_inferred None Crm Inbound Endpoints Delete
crm.inbound.endpoints.list READ crm.read webhooks source_inferred None Crm Inbound Endpoints List
crm.inbound.endpoints.save WRITE crm.write webhooks source_inferred None Crm Inbound Endpoints Save
crm.inbound.endpoints.test WRITE crm.write webhooks source_inferred None Crm Inbound Endpoints Test
crm.leaderboard READ crm.read, admin crm route_inferred None Crm Leaderboard
crm.lifecycle.evaluate WRITE crm.write crm_automation source_inferred None Crm Lifecycle Evaluate
crm.lifecycle.rules.delete WRITE crm.write crm_automation source_inferred None Crm Lifecycle Rules Delete
crm.lifecycle.rules.list READ crm.read crm_automation source_inferred None Crm Lifecycle Rules List
crm.lifecycle.rules.save WRITE crm.write crm_automation source_inferred None Crm Lifecycle Rules Save
crm.list READ crm.read, admin crm route_inferred None Contacts List
crm.mailbox.status READ crm.read, admin crm declared_dynamic None Crm Mailbox Status
crm.meeting.book WRITE crm.write, admin crm route_inferred None Crm Meeting Book
crm.meeting.cancel WRITE crm.write, admin crm route_inferred None Crm Meeting Cancel
crm.meeting.list READ crm.read, admin crm route_inferred None Crm Meeting List
crm.meeting.reschedule.accept WRITE crm.write, admin crm route_inferred None Crm Meeting Reschedule Accept
crm.meeting.reschedule.reject WRITE crm.write, admin crm route_inferred None Crm Meeting Reschedule Reject
crm.merge WRITE crm.write, admin crm route_inferred None Contact Merge
crm.message.send WRITE crm.write, admin crm route_inferred None Crm Message Send
crm.messaging.provider.delete WRITE crm.write, admin crm route_inferred None Crm Messaging Provider Delete
crm.messaging.provider.save WRITE crm.write, admin crm route_inferred None Crm Messaging Provider Save
crm.messaging.provider.test READ crm.read, admin crm route_inferred None Crm Messaging Provider Test
crm.messaging.status READ crm.read, admin crm declared_dynamic None Crm Messaging Status
crm.next.action WRITE crm.write, admin crm route_inferred None Contact Next Action
crm.open.chat READ crm.read, admin crm route_inferred None Contact Open Chat
crm.open.ticket WRITE crm.write, admin crm route_inferred None Contact Open Ticket
crm.outreach.campaigns.delete WRITE crm.write crm_outreach source_inferred None Crm Outreach Campaigns Delete
crm.outreach.campaigns.list READ crm.read crm_outreach source_inferred None Crm Outreach Campaigns List
crm.outreach.campaigns.save WRITE crm.write crm_outreach source_inferred None Crm Outreach Campaigns Save
crm.outreach.campaigns.send WRITE crm.write crm_outreach source_inferred None Crm Outreach Campaigns Send
crm.outreach.send WRITE crm.write crm_outreach source_inferred None Crm Outreach Send
crm.outreach.templates.delete WRITE crm.write crm_outreach source_inferred None Crm Outreach Templates Delete
crm.outreach.templates.list READ crm.read crm_outreach source_inferred None Crm Outreach Templates List
crm.outreach.templates.preview READ crm.read crm_outreach source_inferred None Crm Outreach Templates Preview
crm.outreach.templates.save WRITE crm.write crm_outreach source_inferred None Crm Outreach Templates Save
crm.payments.status READ crm.read, admin crm declared_dynamic None Crm Payments Status
crm.pipeline.data READ crm.read, admin crm declared_dynamic None Crm Pipeline Data
crm.privacy_settings.get READ crm.read crm source_inferred None Crm Privacy Settings Get
crm.privacy_settings.save WRITE admin crm source_inferred None Crm Privacy Settings Save
crm.product.archive WRITE crm.write, admin crm route_inferred None Crm Product Archive
crm.product.revenue READ crm.read, admin crm declared_dynamic None Crm Product Revenue
crm.product.save WRITE crm.write, admin crm declared_dynamic None Crm Product Save
crm.products.list READ crm.read, admin crm route_inferred None Crm Products List
crm.propose.meeting READ crm.read, admin crm route_inferred None Crm Propose Meeting
crm.propose.outreach WRITE crm.write, admin crm declared_dynamic None Crm Propose Outreach
crm.prospecting.dashboard READ crm.read, admin crm declared_dynamic None Crm Prospecting Dashboard
crm.prospecting.icp.save WRITE crm.write, admin crm declared_dynamic None Crm Prospecting Icp Save
crm.prospecting.import WRITE crm.write, admin crm route_inferred None Crm Prospecting Import
crm.prospecting.research READ crm.read, admin crm declared_dynamic None Crm Prospecting Research
crm.prospecting.score READ crm.read, admin crm route_inferred None Crm Prospecting Score
crm.prospecting.sequence READ crm.read, admin crm route_inferred None Crm Prospecting Sequence
crm.qualification.checklist.get READ crm.read, admin crm declared_dynamic None Crm Qualification Checklist Get
crm.qualification.checklist.save WRITE crm.write, admin crm declared_dynamic None Crm Qualification Checklist Save
crm.quota.save WRITE crm.write, admin crm route_inferred None Crm Quota Save
crm.quote.get READ crm.read, admin crm route_inferred None Crm Quote Get
crm.quote.save WRITE crm.write, admin crm route_inferred None Crm Quote Save
crm.quotes.list READ crm.read, admin crm route_inferred None Crm Quotes List
crm.restore.email.consent READ crm.read, admin crm route_inferred None Contact Restore Email Consent
crm.resync.from.platform WRITE crm.write, admin crm route_inferred None Contact Resync From Platform
crm.revert WRITE crm.write, admin crm declared_dynamic None Crm Revert
crm.save WRITE crm.write, admin crm route_inferred None Contact Save
crm.scoring.rule.ai READ crm.read, admin crm route_inferred None Crm Scoring Rule Ai
crm.scoring.rule.delete WRITE crm.write, admin crm route_inferred None Crm Scoring Rule Delete
crm.scoring.rule.list READ crm.read, admin crm declared_dynamic None Crm Scoring Rule List
crm.scoring.rule.save WRITE crm.write, admin crm route_inferred None Crm Scoring Rule Save
crm.segments.delete WRITE crm.write crm source_inferred None Crm Segments Delete
crm.segments.list READ crm.read crm source_inferred None Crm Segments List
crm.segments.members READ crm.read crm source_inferred None Crm Segments Members
crm.segments.preview READ crm.read crm source_inferred None Crm Segments Preview
crm.segments.save WRITE crm.write crm source_inferred None Crm Segments Save
crm.segments.suggestions.accept WRITE crm.write crm source_inferred None Crm Segments Suggestions Accept
crm.segments.suggestions.dismiss WRITE crm.write crm source_inferred None Crm Segments Suggestions Dismiss
crm.segments.suggestions.list READ crm.read crm source_inferred None Crm Segments Suggestions List
crm.semantic.search READ crm.read, admin crm route_inferred None Crm Semantic Search
crm.send.email WRITE crm.write, admin crm route_inferred None Contact Send Email
crm.send.email.route.crm.send.email WRITE crm.write, admin crm route_inferred None Crm Send Email
crm.send.for.signature WRITE crm.write, admin crm route_inferred None Crm Send For Signature
crm.send.payment.link WRITE crm.write, admin crm route_inferred None Crm Send Payment Link
crm.sequence.action READ crm.read, admin crm route_inferred None Crm Sequence Action
crm.sequence.runs READ crm.read, admin crm route_inferred None Crm Sequence Runs
crm.setup.status READ crm.read, admin crm declared_dynamic None Crm Setup Status
crm.subscriptions.list READ crm.read, admin crm route_inferred None Crm Subscriptions List
crm.subscriptions.rollup READ crm.read, admin crm declared_dynamic None Crm Subscriptions Rollup
crm.subscriptions.sync WRITE crm.write, admin crm declared_dynamic None Crm Subscriptions Sync
crm.task.create WRITE crm.write, admin crm declared_dynamic None Crm Task Create
crm.tasks.list READ crm.read, admin crm declared_dynamic None Crm Tasks List
crm.team.save WRITE crm.write, admin crm route_inferred None Crm Team Save
crm.teams.list READ crm.read, admin crm declared_dynamic None Crm Teams List
crm.territory.set WRITE crm.write, admin crm route_inferred None Crm Territory Set
crm.video.status READ crm.read, admin crm declared_dynamic None Crm Video Status
crm.views.delete WRITE crm.write, admin crm declared_dynamic None Crm Views Delete
crm.views.list READ crm.read, admin crm declared_dynamic None Crm Views List
crm.views.save WRITE crm.write, admin crm declared_dynamic None Crm Views Save
crm.webhooks.delete WRITE crm.write webhooks source_inferred None Crm Webhooks Delete
crm.webhooks.list READ crm.read webhooks explicit None List CRM outbound webhook endpoints and recent deliveries
crm.webhooks.save WRITE crm.write webhooks source_inferred None Crm Webhooks Save
crm.webhooks.test WRITE crm.write webhooks source_inferred None Crm Webhooks Test
crm.workflows.delete WRITE crm.write crm_automation source_inferred None Crm Workflows Delete
crm.workflows.list READ crm.read crm_automation source_inferred None Crm Workflows List
crm.workflows.save WRITE crm.write crm_automation source_inferred None Crm Workflows Save
customers — 44 actions
ActionKindScopePlan featureContractRequired fieldsSummary
customers.analyze WRITE customers.write, journey.write, admin crm explicit client_id Analyze a customer journey with AI
customers.behaviour READ customers.read, admin crm route_inferred None Cdp Behaviour
customers.behaviour.analyze WRITE customers.write, admin crm route_inferred None Cdp Behaviour Analyze
customers.chat.embed.backfill WRITE customers.write, admin crm route_inferred None Client Chat Embed Backfill
customers.chat.embed.status READ customers.read, admin crm declared_dynamic None Client Chat Embed Status
customers.chat.faq.ai.generate WRITE customers.write, admin crm route_inferred None Client Chat Faq Ai Generate
customers.chat.faq.approve.all WRITE customers.write, admin crm declared_dynamic None Client Chat Faq Approve All
customers.chat.faq.delete WRITE customers.write, admin crm route_inferred None Client Chat Faq Delete
customers.chat.faq.delete.all WRITE customers.write, admin crm declared_dynamic None Client Chat Faq Delete All
customers.chat.faq.export WRITE customers.write, admin crm declared_dynamic None Client Chat Faq Export
customers.chat.faq.generate WRITE customers.write, admin crm route_inferred None Client Chat Faq Generate
customers.chat.faq.import WRITE customers.write, admin crm route_inferred None Client Chat Faq Import
customers.chat.faq.list WRITE customers.write, admin crm route_inferred None Client Chat Faq List
customers.chat.faq.save WRITE customers.write, admin crm route_inferred None Client Chat Faq Save
customers.chat.faq.set.help WRITE customers.write, admin crm route_inferred None Client Chat Faq Set Help
customers.chat.faq.set.help.all WRITE customers.write, admin crm route_inferred None Client Chat Faq Set Help All
customers.chat.faq.status WRITE customers.write, admin crm route_inferred None Client Chat Faq Status
customers.chat.grant.upload WRITE customers.write, admin crm route_inferred None Client Chat Grant Upload
customers.chat.help.set.slug WRITE customers.write, admin crm route_inferred None Client Chat Help Set Slug
customers.chat.knowledge.crawl.step WRITE customers.write, admin crm route_inferred None Client Chat Knowledge Crawl Step
customers.chat.knowledge.delete WRITE customers.write, admin crm route_inferred None Client Chat Knowledge Delete
customers.chat.knowledge.delete.all WRITE customers.write, admin crm declared_dynamic None Client Chat Knowledge Delete All
customers.chat.knowledge.delete.duplicates WRITE customers.write, admin crm declared_dynamic None Client Chat Knowledge Delete Duplicates
customers.chat.knowledge.duplicates WRITE customers.write, admin crm declared_dynamic None Client Chat Knowledge Duplicates
customers.chat.knowledge.export.json WRITE customers.write, admin crm declared_dynamic None Client Chat Knowledge Export Json
customers.chat.knowledge.import.json WRITE customers.write, admin crm route_inferred None Client Chat Knowledge Import Json
customers.chat.knowledge.preview WRITE customers.write, admin crm route_inferred None Client Chat Knowledge Preview
customers.chat.knowledge.recrawl WRITE customers.write, admin crm route_inferred None Client Chat Knowledge Recrawl
customers.chat.knowledge.test.url WRITE customers.write, admin crm route_inferred None Client Chat Knowledge Test Url
customers.chat.revoke.upload WRITE customers.write, admin crm route_inferred None Client Chat Revoke Upload
customers.chat.upload.agent.avatar WRITE customers.write, admin crm declared_dynamic None Client Chat Upload Agent Avatar
customers.chat.upload.ai.avatar WRITE customers.write, admin crm declared_dynamic None Client Chat Upload Ai Avatar
customers.chat.upload.icon WRITE customers.write, admin crm declared_dynamic None Client Chat Upload Icon
customers.client.analyze WRITE customers.write, admin crm route_inferred None Cdp Client Analyze
customers.client.delete WRITE customers.write, admin crm route_inferred None Cdp Client Delete
customers.client.export WRITE customers.write, admin crm route_inferred None Cdp Client Export
customers.client.journey READ customers.read, admin crm route_inferred None Cdp Client Journey
customers.client.prepare.outreach WRITE customers.write, admin crm route_inferred None Cdp Client Prepare Outreach
customers.clients.list READ customers.read, admin crm route_inferred None Cdp Clients List
customers.detail READ customers.read, admin crm route_inferred None Client Detail
customers.get READ customers.read, crm.read, admin crm explicit client_id Get a customer profile
customers.journey READ customers.read, journey.read, admin crm explicit client_id Get a complete customer journey
customers.list READ customers.read, crm.read, admin crm explicit None List known customers
customers.outreach.prepare WRITE customers.write, crm.write, admin crm explicit client_id Prepare CRM outreach for a customer
departments — 1 action
ActionKindScopePlan featureContractRequired fieldsSummary
departments.list READ departments.read, admin Any plan source_inferred None Departments List
engagement — 141 actions
ActionKindScopePlan featureContractRequired fieldsSummary
engagement.ab.autowinner WRITE engagement.write, admin Any plan route_inferred None Promo Ab Autowinner
engagement.ab.bandit READ engagement.read, admin Any plan route_inferred None Promo Ab Bandit
engagement.ai.agent READ engagement.read, admin Any plan route_inferred None Promo Ai Agent
engagement.ai.analyze WRITE engagement.write, admin Any plan route_inferred None Promo Ai Analyze
engagement.ai.compile.profile READ engagement.read, admin Any plan route_inferred None Promo Ai Compile Profile
engagement.ai.copy READ engagement.read, admin Any plan route_inferred None Promo Ai Copy
engagement.ai.critique READ engagement.read, admin Any plan declared_dynamic None Promo Ai Critique
engagement.ai.decide READ engagement.read, admin Any plan route_inferred None Promo Ai Decide
engagement.ai.design READ engagement.read, admin Any plan route_inferred None Promo Ai Design
engagement.ai.edit WRITE engagement.write, admin Any plan route_inferred None Promo Ai Edit
engagement.ai.generate WRITE engagement.write, admin Any plan route_inferred None Promo Ai Generate
engagement.ai.ideas READ engagement.read, admin Any plan declared_dynamic None Promo Ai Ideas
engagement.ai.image WRITE engagement.write, admin Any plan route_inferred None Promo Ai Image
engagement.ai.image.edit WRITE engagement.write, admin Any plan route_inferred None Promo Ai Image Edit
engagement.ai.localize READ engagement.read, admin Any plan route_inferred None Promo Ai Localize
engagement.ai.logo READ engagement.read, admin Any plan route_inferred None Promo Ai Logo
engagement.ai.media.jobs READ engagement.read, admin Any plan declared_dynamic None Promo Ai Media Jobs
engagement.ai.narrative READ engagement.read, admin Any plan declared_dynamic None Promo Ai Narrative
engagement.ai.responsive READ engagement.read, admin Any plan declared_dynamic None Promo Ai Responsive
engagement.ai.variants READ engagement.read, admin Any plan route_inferred None Promo Ai Variants
engagement.ai.video.start WRITE engagement.write, admin Any plan route_inferred None Promo Ai Video Start
engagement.ai.video.status WRITE engagement.write, admin Any plan route_inferred None Promo Ai Video Status
engagement.approval.decide READ engagement.read, admin Any plan route_inferred None Promo Approval Decide
engagement.approval.request READ engagement.read, admin Any plan route_inferred None Promo Approval Request
engagement.approvals.list READ engagement.read, admin Any plan route_inferred None Promo Approvals List
engagement.asset.delete WRITE engagement.write, admin Any plan route_inferred None Promo Asset Delete
engagement.asset.upload WRITE engagement.write, admin Any plan route_inferred None Promo Asset Upload
engagement.assets.list READ engagement.read, admin Any plan declared_dynamic None Promo Assets List
engagement.audience.materialize WRITE engagement.write, admin surveys route_inferred None Survey Audience Materialize
engagement.audience.save WRITE engagement.write, admin surveys route_inferred None Survey Audience Save
engagement.audience.test READ engagement.read, admin Any plan route_inferred None Promo Audience Test
engagement.audit.export READ engagement.read, admin Any plan declared_dynamic None Promo Audit Export
engagement.autoresponder.get READ engagement.read, admin Any plan route_inferred None Promo Autoresponder Get
engagement.autoresponder.save WRITE engagement.write, admin Any plan route_inferred None Promo Autoresponder Save
engagement.blackouts.get READ engagement.read, admin Any plan declared_dynamic None Promo Blackouts Get
engagement.blackouts.save WRITE engagement.write, admin Any plan route_inferred None Promo Blackouts Save
engagement.brand.kit.bootstrap WRITE engagement.write, admin Any plan route_inferred None Promo Brand Kit Bootstrap
engagement.brand.kit.font.upload WRITE engagement.write, admin Any plan route_inferred None Promo Brand Kit Font Upload
engagement.brand.kit.get READ engagement.read, admin Any plan declared_dynamic None Promo Brand Kit Get
engagement.brand.kit.save WRITE engagement.write, admin Any plan declared_dynamic None Promo Brand Kit Save
engagement.campaign.archive WRITE engagement.write, admin Any plan route_inferred None Promo Campaign Archive
engagement.campaign.delete WRITE engagement.write, admin Any plan route_inferred None Promo Campaign Delete
engagement.campaign.duplicate READ engagement.read, admin Any plan route_inferred None Promo Campaign Duplicate
engagement.campaign.get READ engagement.read, admin Any plan route_inferred None Promo Campaign Get
engagement.campaign.launch WRITE engagement.write, admin surveys route_inferred None Survey Campaign Launch
engagement.campaign.list READ engagement.read, admin Any plan route_inferred None Promo Campaign List
engagement.campaign.pause READ engagement.read, admin Any plan route_inferred None Promo Campaign Pause
engagement.campaign.preview READ engagement.read, admin Any plan route_inferred None Promo Campaign Preview
engagement.campaign.publish WRITE engagement.write, admin Any plan route_inferred None Promo Campaign Publish
engagement.campaign.rollback WRITE engagement.write, admin Any plan route_inferred None Promo Campaign Rollback
engagement.campaign.save WRITE engagement.write, admin Any plan route_inferred None Promo Campaign Save
engagement.campaign.save.route.survey.campaign.save WRITE engagement.write, admin surveys route_inferred None Survey Campaign Save
engagement.campaign.toggle WRITE engagement.write, admin Any plan route_inferred None Promo Campaign Toggle
engagement.campaign.versions READ engagement.read, admin Any plan route_inferred None Promo Campaign Versions
engagement.comment.add WRITE engagement.write, admin Any plan route_inferred None Promo Comment Add
engagement.comments.list READ engagement.read, admin Any plan route_inferred None Promo Comments List
engagement.connectors.catalog READ engagement.read, admin Any plan declared_dynamic None Promo Connectors Catalog
engagement.coupon.providers READ engagement.read, admin Any plan declared_dynamic None Promo Coupon Providers
engagement.coupons.clear WRITE engagement.write, admin Any plan route_inferred None Promo Coupons Clear
engagement.coupons.stats READ engagement.read, admin Any plan route_inferred None Promo Coupons Stats
engagement.coupons.upload WRITE engagement.write, admin Any plan route_inferred None Promo Coupons Upload
engagement.delete WRITE engagement.write, admin proactive_engagement route_inferred None Announcement Delete
engagement.delete.route.tour.delete WRITE engagement.write, admin proactive_engagement route_inferred None Tour Delete
engagement.delivery.analytics READ engagement.read, admin surveys route_inferred None Survey Delivery Analytics
engagement.delivery.dashboard READ engagement.read, admin surveys route_inferred None Survey Delivery Dashboard
engagement.deployment.publish WRITE engagement.write, admin surveys route_inferred None Survey Deployment Publish
engagement.deployment.save WRITE engagement.write, admin surveys route_inferred None Survey Deployment Save
engagement.deployment.status WRITE engagement.write, admin surveys route_inferred None Survey Deployment Status
engagement.detail READ engagement.read, admin Any plan route_inferred None Campaign Detail
engagement.feed.catalog READ engagement.read, admin Any plan declared_dynamic None Promo Feed Catalog
engagement.feed.items READ engagement.read, admin Any plan route_inferred None Promo Feed Items
engagement.geo.preview READ engagement.read, admin Any plan route_inferred None Promo Geo Preview
engagement.idle.cron.set WRITE engagement.write, admin proactive_engagement route_inferred None Proactive Idle Cron Set
engagement.import.create WRITE engagement.write, admin surveys route_inferred None Survey Import Create
engagement.import.replay WRITE engagement.write, admin surveys route_inferred None Survey Import Replay
engagement.leads.export READ engagement.read, admin Any plan route_inferred None Promo Leads Export
engagement.leads.list READ engagement.read, admin Any plan route_inferred None Promo Leads List
engagement.list READ engagement.read, admin proactive_engagement declared_dynamic None Announcements List
engagement.list.route.tours.list READ engagement.read, admin proactive_engagement declared_dynamic None Tours List
engagement.module.set.ai.live WRITE engagement.write, admin Any plan route_inferred None Promo Module Set Ai Live
engagement.module.set.custom.html WRITE engagement.write, admin Any plan route_inferred None Promo Module Set Custom Html
engagement.module.set.enabled WRITE engagement.write, admin Any plan route_inferred None Promo Module Set Enabled
engagement.module.status READ engagement.read, admin Any plan declared_dynamic None Promo Module Status
engagement.onsite.preview READ engagement.read, admin Any plan route_inferred None Promo Onsite Preview
engagement.pause.all READ engagement.read, admin Any plan declared_dynamic None Promo Pause All
engagement.presence READ engagement.read, admin Any plan route_inferred None Promo Presence
engagement.preview.share READ engagement.read, admin Any plan route_inferred None Promo Preview Share
engagement.push.draft WRITE engagement.write, admin Any plan route_inferred None Promo Push Draft
engagement.recipients.issue WRITE engagement.write, admin surveys route_inferred None Survey Recipients Issue
engagement.recipients.list READ engagement.read, admin surveys route_inferred None Survey Recipients List
engagement.recipients.revoke WRITE engagement.write, admin surveys route_inferred None Survey Recipients Revoke
engagement.response.detail READ engagement.read, admin surveys route_inferred None Survey Response Detail
engagement.responses.browse READ engagement.read, admin surveys route_inferred None Survey Responses Browse
engagement.rule.delete WRITE engagement.write, admin proactive_engagement route_inferred None Proactive Rule Delete
engagement.rule.save WRITE engagement.write, admin proactive_engagement route_inferred None Proactive Rule Save
engagement.rule.stats READ engagement.read, admin proactive_engagement route_inferred None Proactive Rule Stats
engagement.rule.test READ engagement.read, admin Any plan route_inferred None Promo Rule Test
engagement.rule.toggle WRITE engagement.write, admin proactive_engagement route_inferred None Proactive Rule Toggle
engagement.rules.list READ engagement.read, admin proactive_engagement declared_dynamic None Proactive Rules List
engagement.save WRITE engagement.write, admin proactive_engagement route_inferred None Announcement Save
engagement.save.route.tour.save WRITE engagement.write, admin proactive_engagement route_inferred None Tour Save
engagement.stats READ engagement.read, admin Any plan route_inferred None Promo Stats
engagement.stats.route.tour.stats READ engagement.read, admin proactive_engagement route_inferred None Tour Stats
engagement.studio.ai.generate WRITE engagement.write, admin surveys route_inferred None Survey Studio Ai Generate
engagement.studio.ai.insights WRITE engagement.write, admin surveys route_inferred None Survey Studio Ai Insights
engagement.studio.ai.target WRITE engagement.write, admin surveys route_inferred None Survey Studio Ai Target
engagement.studio.archive WRITE engagement.write, admin surveys route_inferred None Survey Studio Archive
engagement.studio.assets READ engagement.read, admin surveys declared_dynamic None Survey Studio Assets
engagement.studio.create WRITE engagement.write, admin surveys route_inferred None Survey Studio Create
engagement.studio.delete WRITE engagement.write, admin surveys route_inferred None Survey Studio Delete
engagement.studio.duplicate WRITE engagement.write, admin surveys route_inferred None Survey Studio Duplicate
engagement.studio.event READ engagement.read, admin Any plan route_inferred None Promo Studio Event
engagement.studio.get READ engagement.read, admin surveys route_inferred None Survey Studio Get
engagement.studio.list READ engagement.read, admin surveys declared_dynamic None Survey Studio List
engagement.studio.preview READ engagement.read, admin surveys route_inferred None Survey Studio Preview
engagement.studio.preview.link READ engagement.read, admin surveys route_inferred None Survey Studio Preview Link
engagement.studio.publish WRITE engagement.write, admin surveys route_inferred None Survey Studio Publish
engagement.studio.rename WRITE engagement.write, admin surveys route_inferred None Survey Studio Rename
engagement.studio.revert WRITE engagement.write, admin surveys route_inferred None Survey Studio Revert
engagement.studio.save.draft WRITE engagement.write, admin surveys route_inferred None Survey Studio Save Draft
engagement.studio.save.targeting WRITE engagement.write, admin surveys route_inferred None Survey Studio Save Targeting
engagement.studio.set.active WRITE engagement.write, admin surveys route_inferred None Survey Studio Set Active
engagement.studio.upload WRITE engagement.write, admin surveys route_inferred None Survey Studio Upload
engagement.studio.webhook WRITE engagement.write, admin surveys route_inferred None Survey Studio Webhook
engagement.template.apply WRITE engagement.write, admin Any plan route_inferred None Promo Template Apply
engagement.template.list READ engagement.read, admin Any plan route_inferred None Promo Template List
engagement.template.save.custom WRITE engagement.write, admin Any plan route_inferred None Promo Template Save Custom
engagement.toggle WRITE engagement.write, admin proactive_engagement route_inferred None Announcement Toggle
engagement.toggle.route.tour.toggle WRITE engagement.write, admin proactive_engagement route_inferred None Tour Toggle
engagement.trigger.set.save WRITE engagement.write, admin surveys route_inferred None Survey Trigger Set Save
engagement.variant.delete WRITE engagement.write, admin Any plan route_inferred None Promo Variant Delete
engagement.variant.list READ engagement.read, admin Any plan route_inferred None Promo Variant List
engagement.variant.promote READ engagement.read, admin Any plan route_inferred None Promo Variant Promote
engagement.variant.save WRITE engagement.write, admin Any plan route_inferred None Promo Variant Save
engagement.version.get READ engagement.read, admin Any plan route_inferred None Promo Version Get
engagement.version.label READ engagement.read, admin Any plan route_inferred None Promo Version Label
engagement.webhook.delete WRITE engagement.write, admin surveys route_inferred None Survey Webhook Delete
engagement.webhook.replay WRITE engagement.write, admin surveys route_inferred None Survey Webhook Replay
engagement.webhook.run WRITE engagement.write, admin surveys route_inferred None Survey Webhook Run
engagement.webhook.save WRITE engagement.write, admin surveys route_inferred None Survey Webhook Save
engagement.widget.data READ engagement.read, admin proactive_engagement declared_dynamic None Tour Widget Data
feedback — 8 actions
ActionKindScopePlan featureContractRequired fieldsSummary
feedback.analytics READ feedback.read, admin surveys compatibility None Feedback Analytics
feedback.detractors READ feedback.read, admin surveys compatibility None Feedback Detractors
feedback.get READ feedback.read, admin surveys compatibility None Feedback Get
feedback.ingest WRITE feedback.write, admin surveys compatibility None Feedback Ingest
feedback.list READ feedback.read, admin surveys compatibility None Feedback List
feedback.overview READ feedback.read, admin surveys compatibility None Feedback Overview
feedback.sources.list READ feedback.read, admin surveys compatibility None Feedback Sources List
feedback.update WRITE feedback.write, admin surveys compatibility None Feedback Update
files — 1 action
ActionKindScopePlan featureContractRequired fieldsSummary
files.get READ files.read, admin Any plan source_inferred None Files Get
intent — 6 actions
ActionKindScopePlan featureContractRequired fieldsSummary
intent.clear WRITE intent.write, admin analytics declared_dynamic None Intent Clear
intent.funnel READ intent.read, analytics.read, admin analytics explicit None Read the intent funnel
intent.funnel.aggregate READ intent.read, admin analytics route_inferred None Intent Funnel Aggregate
intent.funnel.route.intent.funnel READ intent.read, admin analytics route_inferred None Intent Funnel
intent.summary READ intent.read, analytics.read, admin analytics explicit None Read intent summaries
intent.summary.route.intent.summary READ intent.read, admin analytics route_inferred None Intent Summary
kb — 6 actions
ActionKindScopePlan featureContractRequired fieldsSummary
kb.faq.delete WRITE kb.write, admin knowledge_training source_inferred None Kb Faq Delete
kb.faq.generate WRITE kb.write, admin knowledge_training source_inferred None Kb Faq Generate
kb.faq.import WRITE kb.write, admin knowledge_training source_inferred None Kb Faq Import
kb.faq.list READ kb.read, read, admin knowledge_training source_inferred None Kb Faq List
kb.faq.save WRITE kb.write, admin knowledge_training source_inferred None Kb Faq Save
kb.faq.set_status WRITE kb.write, admin knowledge_training source_inferred None Kb Faq Set Status
knowledge — 72 actions
ActionKindScopePlan featureContractRequired fieldsSummary
knowledge.analytics.get READ kb.read, admin Any plan route_inferred None Help Analytics Get
knowledge.analytics.toggle WRITE kb.write, admin Any plan route_inferred None Help Analytics Toggle
knowledge.article.ai.refine READ kb.read, admin Any plan route_inferred None Help Article Ai Refine
knowledge.article.delete WRITE kb.write, admin Any plan route_inferred None Help Article Delete
knowledge.article.publish WRITE kb.write, admin Any plan route_inferred None Help Article Publish
knowledge.article.save WRITE kb.write, admin Any plan route_inferred None Help Article Save
knowledge.article.set.category WRITE kb.write, admin Any plan route_inferred None Help Article Set Category
knowledge.article.set.public WRITE kb.write, admin Any plan route_inferred None Help Article Set Public
knowledge.articles.ai.generate WRITE kb.write, admin Any plan route_inferred None Help Articles Ai Generate
knowledge.articles.bulk.delete WRITE kb.write, admin Any plan route_inferred None Help Articles Bulk Delete
knowledge.articles.count READ kb.read, admin Any plan declared_dynamic None Help Articles Count
knowledge.articles.ids READ kb.read, admin Any plan route_inferred None Help Articles Ids
knowledge.articles.list READ kb.read, admin Any plan route_inferred None Help Articles List
knowledge.articles.set.public.all WRITE kb.write, admin Any plan route_inferred None Help Articles Set Public All
knowledge.categories.ai.merge WRITE kb.write, admin Any plan declared_dynamic None Help Categories Ai Merge
knowledge.categories.bulk.delete WRITE kb.write, admin Any plan route_inferred None Help Categories Bulk Delete
knowledge.categories.list READ kb.read, admin Any plan declared_dynamic None Help Categories List
knowledge.categories.merge.dupes WRITE kb.write, admin Any plan declared_dynamic None Help Categories Merge Dupes
knowledge.category.delete WRITE kb.write, admin Any plan route_inferred None Help Category Delete
knowledge.category.get READ kb.read, admin Any plan route_inferred None Help Category Get
knowledge.category.save WRITE kb.write, admin Any plan route_inferred None Help Category Save
knowledge.center.article.image.upload WRITE kb.write, admin Any plan declared_dynamic None Help Center Article Image Upload
knowledge.center.favicon.upload WRITE kb.write, admin Any plan declared_dynamic None Help Center Favicon Upload
knowledge.center.hero.dark.upload WRITE kb.write, admin Any plan declared_dynamic None Help Center Hero Dark Upload
knowledge.center.hero.upload WRITE kb.write, admin Any plan declared_dynamic None Help Center Hero Upload
knowledge.center.logo.dark.upload WRITE kb.write, admin Any plan declared_dynamic None Help Center Logo Dark Upload
knowledge.center.logo.upload WRITE kb.write, admin Any plan declared_dynamic None Help Center Logo Upload
knowledge.center.settings.get READ kb.read, admin Any plan declared_dynamic None Help Center Settings Get
knowledge.center.settings.save WRITE kb.write, admin Any plan declared_dynamic None Help Center Settings Save
knowledge.center.translate.estimate WRITE kb.write, admin Any plan declared_dynamic None Help Center Translate Estimate
knowledge.center.translate.run WRITE kb.write, admin Any plan route_inferred None Help Center Translate Run
knowledge.center.translate.status READ kb.read, admin Any plan declared_dynamic None Help Center Translate Status
knowledge.center.translate.stop WRITE kb.write, admin Any plan declared_dynamic None Help Center Translate Stop
knowledge.center.widget.icon.upload WRITE kb.write, admin Any plan declared_dynamic None Help Center Widget Icon Upload
knowledge.comments.deliver.notifications WRITE kb.write, admin knowledge_training route_inferred None Kb Comments Deliver Notifications
knowledge.comments.maintenance WRITE kb.write, admin Any plan route_inferred None Help Comments Maintenance
knowledge.comments.moderate WRITE kb.write, admin Any plan route_inferred None Help Comments Moderate
knowledge.comments.moderate.route.kb.comments.moderate WRITE kb.write, admin knowledge_training route_inferred None Kb Comments Moderate
knowledge.comments.moderation.list READ kb.read, admin Any plan route_inferred None Help Comments Moderation List
knowledge.comments.moderation.list.route.kb.comments.moderation.list READ kb.read, admin knowledge_training route_inferred None Kb Comments Moderation List
knowledge.comments.notification.run WRITE kb.write, admin Any plan route_inferred None Help Comments Notification Run
knowledge.import.batches WRITE kb.write, admin knowledge_training route_inferred None Kb Import Batches
knowledge.import.connectors WRITE kb.write, admin knowledge_training declared_dynamic None Kb Import Connectors
knowledge.import.csv.preview READ kb.read, admin knowledge_training route_inferred None Kb Import Csv Preview
knowledge.import.preview WRITE kb.write, admin knowledge_training route_inferred None Kb Import Preview
knowledge.import.resync WRITE kb.write, admin knowledge_training route_inferred None Kb Import Resync
knowledge.import.run WRITE kb.write, admin knowledge_training route_inferred None Kb Import Run
knowledge.import.undo WRITE kb.write, admin knowledge_training route_inferred None Kb Import Undo
knowledge.insights.generate WRITE kb.write, admin Any plan route_inferred None Help Insights Generate
knowledge.insights.get READ kb.read, admin Any plan declared_dynamic None Help Insights Get
knowledge.missed.dismiss WRITE kb.write, admin knowledge_training route_inferred None Kb Missed Dismiss
knowledge.missed.draft.article WRITE kb.write, admin knowledge_training route_inferred None Kb Missed Draft Article
knowledge.missed.list READ kb.read, admin knowledge_training route_inferred None Kb Missed List
knowledge.missed.mark.published READ kb.read, admin knowledge_training route_inferred None Kb Missed Mark Published
knowledge.missed.refresh WRITE kb.write, admin knowledge_training declared_dynamic None Kb Missed Refresh
knowledge.organize.descriptions WRITE kb.write, admin Any plan declared_dynamic None Help Organize Descriptions
knowledge.organize.status WRITE kb.write, admin Any plan declared_dynamic None Help Organize Status
knowledge.organize.step WRITE kb.write, admin Any plan route_inferred None Help Organize Step
knowledge.publish WRITE kb.write, admin knowledge_training route_inferred None Kb Publish
knowledge.reformat.revert WRITE kb.write, admin Any plan declared_dynamic None Help Reformat Revert
knowledge.reformat.status READ kb.read, admin Any plan declared_dynamic None Help Reformat Status
knowledge.reformat.step WRITE kb.write, admin Any plan route_inferred None Help Reformat Step
knowledge.set.featured WRITE kb.write, admin Any plan route_inferred None Help Set Featured
knowledge.subdomain.allocate WRITE kb.write, admin Any plan route_inferred None Help Subdomain Allocate
knowledge.subdomain.check READ kb.read, admin Any plan route_inferred None Help Subdomain Check
knowledge.subdomain.release WRITE kb.write, admin Any plan route_inferred None Help Subdomain Release
knowledge.taxonomy.organize WRITE kb.write, admin knowledge_training declared_dynamic None Kb Taxonomy Organize
knowledge.taxonomy.status READ kb.read, admin knowledge_training declared_dynamic None Kb Taxonomy Status
knowledge.taxonomy.step WRITE kb.write, admin knowledge_training route_inferred None Kb Taxonomy Step
knowledge.widget.categories READ kb.read, admin knowledge_training route_inferred None Kb Widget Categories
knowledge.widget.publish WRITE kb.write, admin knowledge_training route_inferred None Kb Widget Publish
knowledge.widget.targets READ kb.read, admin knowledge_training declared_dynamic None Kb Widget Targets
leads — 6 actions
ActionKindScopePlan featureContractRequired fieldsSummary
leads.delete WRITE leads.write, crm.write, admin lead_intelligence explicit lead_id Delete a lead
leads.delete.route.lead.delete WRITE leads.write, admin lead_intelligence route_inferred None Lead Delete
leads.list READ leads.read, crm.read, admin lead_intelligence explicit None List leads
leads.stats READ leads.read, analytics.read, admin lead_intelligence explicit None Get lead statistics
leads.stats.route.leads.stats READ leads.read, admin lead_intelligence declared_dynamic None Leads Stats
leads.update WRITE leads.write, crm.write, admin lead_intelligence explicit lead_id, status Update a lead
meta — 4 actions
ActionKindScopePlan featureContractRequired fieldsSummary
meta.action READ Any plan explicit name Get one General API action contract
meta.actions READ Any plan explicit None List the complete General API contract
meta.me READ Any plan explicit None Describe the authenticated API key and active workspace
meta.scopes READ Any plan explicit None List API scopes and the actions protected by each scope
notifications — 1 action
ActionKindScopePlan featureContractRequired fieldsSummary
notifications.list READ notifications.read, admin Any plan source_inferred None Notifications List
platform — 311 actions
ActionKindScopePlan featureContractRequired fieldsSummary
platform.add.announcement WRITE platform.write, admin Any plan declared_dynamic None Add Announcement
platform.add.kb.article WRITE platform.write, admin Any plan route_inferred None Add Kb Article
platform.add.todo.item WRITE platform.write, admin Any plan route_inferred None Add Todo Item
platform.ai.action.lookup WRITE platform.write, admin Any plan route_inferred None Ai Action Lookup
platform.ai.anomaly.detect READ platform.read, admin Any plan route_inferred None Ai Anomaly Detect
platform.ai.brain.add WRITE platform.write, admin ai_chat route_inferred None Ai Brain Add
platform.ai.brain.delete WRITE platform.write, admin ai_chat route_inferred None Ai Brain Delete
platform.ai.brain.edit WRITE platform.write, admin ai_chat route_inferred None Ai Brain Edit
platform.ai.brain.list WRITE platform.write, admin ai_chat route_inferred None Ai Brain List
platform.ai.brain.pin WRITE platform.write, admin ai_chat route_inferred None Ai Brain Pin
platform.ai.brain.status WRITE platform.write, admin ai_chat route_inferred None Ai Brain Status
platform.ai.chat WRITE platform.write, admin ai_chat route_inferred None Ai Chat
platform.ai.confidence.stats READ platform.read, admin Any plan declared_dynamic None Ai Confidence Stats
platform.ai.context.lookup WRITE platform.write, admin Any plan route_inferred None Ai Context Lookup
platform.ai.daily.brief WRITE platform.write, admin Any plan route_inferred None Ai Daily Brief
platform.ai.daily.brief.check READ platform.read, admin Any plan declared_dynamic None Ai Daily Brief Check
platform.ai.daily.brief.dismiss WRITE platform.write, admin Any plan declared_dynamic None Ai Daily Brief Dismiss
platform.ai.daily.brief.fetch READ platform.read, admin Any plan route_inferred None Ai Daily Brief Fetch
platform.ai.eval.control.summary READ platform.read, admin Any plan declared_dynamic None Ai Eval Control Summary
platform.ai.eval.feedback.queue READ platform.read, admin Any plan declared_dynamic None Ai Eval Feedback Queue
platform.ai.eval.kb.gap.queue READ platform.read, admin Any plan declared_dynamic None Ai Eval Kb Gap Queue
platform.ai.eval.load READ platform.read, admin Any plan declared_dynamic None Ai Eval Load
platform.ai.eval.replay.history WRITE platform.write, admin Any plan declared_dynamic None Ai Eval Replay History
platform.ai.eval.run WRITE platform.write, admin Any plan declared_dynamic None Ai Eval Run
platform.ai.eval.save WRITE platform.write, admin Any plan declared_dynamic None Ai Eval Save
platform.ai.eval.score.answer READ platform.read, admin Any plan declared_dynamic None Ai Eval Score Answer
platform.ai.eval.simulate READ platform.read, admin Any plan route_inferred None Ai Eval Simulate
platform.ai.feedback.analysis READ platform.read, admin Any plan declared_dynamic None Ai Feedback Analysis
platform.ai.feedback.stats READ platform.read, admin Any plan declared_dynamic None Ai Feedback Stats
platform.ai.history.archive WRITE platform.write, admin Any plan declared_dynamic None Ai History Archive
platform.ai.history.clear.all WRITE platform.write, admin Any plan declared_dynamic None Ai History Clear All
platform.ai.history.delete WRITE platform.write, admin Any plan declared_dynamic None Ai History Delete
platform.ai.history.export.csv WRITE platform.write, admin Any plan declared_dynamic None Ai History Export Csv
platform.ai.history.get WRITE platform.write, admin Any plan declared_dynamic None Ai History Get
platform.ai.history.list WRITE platform.write, admin Any plan declared_dynamic None Ai History List
platform.ai.history.stats WRITE platform.write, admin Any plan declared_dynamic None Ai History Stats
platform.ai.insight.clear WRITE platform.write, admin Any plan route_inferred None Ai Insight Clear
platform.ai.insight.history READ platform.read, admin Any plan route_inferred None Ai Insight History
platform.ai.insight.report.delete WRITE platform.write, admin Any plan route_inferred None Ai Insight Report Delete
platform.ai.insight.report.get READ platform.read, admin Any plan route_inferred None Ai Insight Report Get
platform.ai.instructions.compress WRITE platform.write, admin Any plan declared_dynamic None Ai Instructions Compress
platform.ai.instructions.connector.templates READ platform.read, admin Any plan declared_dynamic None Ai Instructions Connector Templates
platform.ai.instructions.example READ platform.read, admin Any plan declared_dynamic None Ai Instructions Example
platform.ai.instructions.load WRITE platform.write, admin Any plan declared_dynamic None Ai Instructions Load
platform.ai.instructions.preview READ platform.read, admin Any plan route_inferred None Ai Instructions Preview
platform.ai.instructions.reset WRITE platform.write, admin Any plan declared_dynamic None Ai Instructions Reset
platform.ai.instructions.save WRITE platform.write, admin Any plan declared_dynamic None Ai Instructions Save
platform.ai.page.insights READ platform.read, admin Any plan route_inferred None Ai Page Insights
platform.ai.popup.regen WRITE platform.write, admin Any plan route_inferred None Ai Popup Regen
platform.ai.quality.view READ platform.read, admin Any plan declared_dynamic None Ai Quality View
platform.ai.reasoning.chain.get READ platform.read, admin Any plan route_inferred None Ai Reasoning Chain Get
platform.ai.score.lead WRITE platform.write, admin Any plan route_inferred None Ai Score Lead
platform.ai.smart.alerts READ platform.read, admin Any plan declared_dynamic None Ai Smart Alerts
platform.ai.triage.accuracy READ platform.read, admin Any plan declared_dynamic None Ai Triage Accuracy
platform.ai.whmcs.chat WRITE platform.write, admin admin_chat route_inferred None Ai Whmcs Chat
platform.ai.writing WRITE platform.write, admin ai_writing route_inferred None Ai Writing
platform.api.keys.catalog READ platform.read, admin api_keys declared_dynamic None Api Keys Catalog
platform.api.keys.create WRITE platform.write, admin api_keys route_inferred None Api Keys Create
platform.api.keys.delete WRITE platform.write, admin api_keys route_inferred None Api Keys Delete
platform.api.keys.list READ platform.read, admin api_keys declared_dynamic None Api Keys List
platform.api.keys.revoke WRITE platform.write, admin api_keys route_inferred None Api Keys Revoke
platform.api.keys.update WRITE platform.write, admin api_keys route_inferred None Api Keys Update
platform.audit.export READ platform.read, admin Any plan route_inferred None Audit Export
platform.blocked WRITE platform.write, admin Any plan route_inferred None Blocked
platform.campaigns READ platform.read, admin Any plan declared_dynamic None Campaigns
platform.chart.browsers READ platform.read, admin Any plan declared_dynamic None Chart Browsers
platform.chart.countries READ platform.read, admin Any plan declared_dynamic None Chart Countries
platform.chart.devices READ platform.read, admin Any plan declared_dynamic None Chart Devices
platform.chart.hourly READ platform.read, admin Any plan declared_dynamic None Chart Hourly
platform.chart.new.returning READ platform.read, admin Any plan declared_dynamic None Chart New Returning
platform.chart.os READ platform.read, admin Any plan declared_dynamic None Chart Os
platform.chart.sources READ platform.read, admin Any plan declared_dynamic None Chart Sources
platform.chart.visitors READ platform.read, admin Any plan route_inferred None Chart Visitors
platform.chatbot.flow.delete WRITE platform.write, admin Any plan route_inferred None Chatbot Flow Delete
platform.chatbot.flow.get READ platform.read, admin Any plan route_inferred None Chatbot Flow Get
platform.chatbot.flow.save WRITE platform.write, admin Any plan route_inferred None Chatbot Flow Save
platform.chatbot.flow.stats READ platform.read, admin Any plan route_inferred None Chatbot Flow Stats
platform.chatbot.flow.test.advance READ platform.read, admin Any plan route_inferred None Chatbot Flow Test Advance
platform.chatbot.flow.test.start WRITE platform.write, admin Any plan route_inferred None Chatbot Flow Test Start
platform.chatbot.flow.toggle WRITE platform.write, admin Any plan route_inferred None Chatbot Flow Toggle
platform.chatbot.flows.list READ platform.read, admin Any plan declared_dynamic None Chatbot Flows List
platform.chatbot.flows.widget.data READ platform.read, admin Any plan declared_dynamic None Chatbot Flows Widget Data
platform.chatbot.node.delete WRITE platform.write, admin Any plan route_inferred None Chatbot Node Delete
platform.chatbot.node.save WRITE platform.write, admin Any plan route_inferred None Chatbot Node Save
platform.chatbot.nodes.list READ platform.read, admin Any plan route_inferred None Chatbot Nodes List
platform.clear.admin.chat.history WRITE platform.write, admin Any plan declared_dynamic None Clear Admin Chat History
platform.command.center.view READ platform.read, admin Any plan declared_dynamic None Command Center View
platform.complete.todo.item WRITE platform.write, admin Any plan route_inferred None Complete Todo Item
platform.consent.log.list READ platform.read, admin Any plan route_inferred None Consent Log List
platform.countries READ platform.read, admin Any plan declared_dynamic None Countries
platform.country.detail READ platform.read, admin Any plan route_inferred None Country Detail
platform.custom.code.approve WRITE platform.write, admin Any plan route_inferred None Custom Code Approve
platform.custom.code.disable WRITE platform.write, admin Any plan route_inferred None Custom Code Disable
platform.custom.code.reject WRITE platform.write, admin Any plan route_inferred None Custom Code Reject
platform.custom.code.rollback WRITE platform.write, admin Any plan route_inferred None Custom Code Rollback
platform.custom.code.status READ platform.read, admin Any plan route_inferred None Custom Code Status
platform.delete.todo.item WRITE platform.write, admin Any plan route_inferred None Delete Todo Item
platform.devices READ platform.read, admin Any plan declared_dynamic None Devices
platform.diag.check.resolutions READ platform.read, admin Any plan declared_dynamic None Diag Check Resolutions
platform.diag.dismiss WRITE platform.write, admin Any plan route_inferred None Diag Dismiss
platform.diag.report WRITE platform.write, admin Any plan route_inferred None Diag Report
platform.dismiss.credit.alert WRITE platform.write, admin Any plan route_inferred None Dismiss Credit Alert
platform.domain.knowledge.ai.generate WRITE platform.write, admin Any plan route_inferred None Domain Knowledge Ai Generate
platform.domain.knowledge.delete WRITE platform.write, admin Any plan route_inferred None Domain Knowledge Delete
platform.domain.knowledge.list WRITE platform.write, admin Any plan route_inferred None Domain Knowledge List
platform.domain.knowledge.save WRITE platform.write, admin Any plan route_inferred None Domain Knowledge Save
platform.domain.knowledge.toggle WRITE platform.write, admin Any plan route_inferred None Domain Knowledge Toggle
platform.domain.verify.add WRITE platform.write, admin Any plan route_inferred None Domain Verify Add
platform.domain.verify.list READ platform.read, admin Any plan declared_dynamic None Domain Verify List
platform.domain.verify.recheck WRITE platform.write, admin Any plan route_inferred None Domain Verify Recheck
platform.domain.verify.remove WRITE platform.write, admin Any plan route_inferred None Domain Verify Remove
platform.dynamic.action.dispatch READ platform.read, admin Any plan route_inferred None Dynamic Action Dispatch
platform.events.clear.all WRITE platform.write, admin Any plan declared_dynamic None Events Clear All
platform.events.list READ platform.read, admin Any plan route_inferred None Events List
platform.experiment.delete WRITE platform.write, admin analytics route_inferred None Experiment Delete
platform.experiment.results READ platform.read, admin analytics route_inferred None Experiment Results
platform.experiment.save WRITE platform.write, admin analytics route_inferred None Experiment Save
platform.experiments.clear.all WRITE platform.write, admin Any plan declared_dynamic None Experiments Clear All
platform.experiments.list READ platform.read, admin Any plan declared_dynamic None Experiments List
platform.failed.logins.clear.all WRITE platform.write, admin Any plan declared_dynamic None Failed Logins Clear All
platform.failed.logins.clear.history WRITE platform.write, admin Any plan declared_dynamic None Failed Logins Clear History
platform.failed.logins.journey WRITE platform.write, admin Any plan route_inferred None Failed Logins Journey
platform.failed.logins.list WRITE platform.write, admin Any plan declared_dynamic None Failed Logins List
platform.failed.logins.unblock WRITE platform.write, admin Any plan route_inferred None Failed Logins Unblock
platform.feedback.analysis.get READ platform.read, admin surveys declared_dynamic None Feedback Analysis Get
platform.feedback.analysis.run WRITE platform.write, admin surveys route_inferred None Feedback Analysis Run
platform.feedback.analytics.all READ platform.read, admin surveys route_inferred None Feedback Analytics All
platform.feedback.analytics.detractors READ platform.read, admin surveys route_inferred None Feedback Analytics Detractors
platform.feedback.analytics.metrics READ platform.read, admin surveys route_inferred None Feedback Analytics Metrics
platform.feedback.analytics.overview READ platform.read, admin surveys route_inferred None Feedback Analytics Overview
platform.feedback.analytics.segments READ platform.read, admin surveys route_inferred None Feedback Analytics Segments
platform.feedback.analytics.sentiment READ platform.read, admin surveys route_inferred None Feedback Analytics Sentiment
platform.feedback.analytics.themes READ platform.read, admin surveys route_inferred None Feedback Analytics Themes
platform.feedback.analytics.trends READ platform.read, admin surveys route_inferred None Feedback Analytics Trends
platform.feedback.assignees.list READ platform.read, admin surveys declared_dynamic None Feedback Assignees List
platform.feedback.event.outbox.drain WRITE platform.write, admin surveys route_inferred None Feedback Event Outbox Drain
platform.feedback.exports.create WRITE platform.write, admin surveys route_inferred None Feedback Exports Create
platform.feedback.exports.get READ platform.read, admin surveys route_inferred None Feedback Exports Get
platform.feedback.external.review.ingest WRITE platform.write, admin surveys route_inferred None Feedback External Review Ingest
platform.feedback.ingest.create WRITE platform.write, admin surveys route_inferred None Feedback Ingest Create
platform.feedback.items.assign WRITE platform.write, admin surveys route_inferred None Feedback Items Assign
platform.feedback.items.evidence READ platform.read, admin surveys route_inferred None Feedback Items Evidence
platform.feedback.items.follow.up.complete WRITE platform.write, admin surveys route_inferred None Feedback Items Follow Up Complete
platform.feedback.items.follow.up.set WRITE platform.write, admin surveys route_inferred bool Feedback Items Follow Up Set
platform.feedback.items.get READ platform.read, admin surveys route_inferred None Feedback Items Get
platform.feedback.items.list READ platform.read, admin surveys route_inferred None Feedback Items List
platform.feedback.items.mark.read WRITE platform.write, admin surveys route_inferred None Feedback Items Mark Read
platform.feedback.items.notes.add WRITE platform.write, admin surveys route_inferred None Feedback Items Notes Add
platform.feedback.items.set.priority WRITE platform.write, admin surveys route_inferred None Feedback Items Set Priority
platform.feedback.items.set.status WRITE platform.write, admin surveys route_inferred None Feedback Items Set Status
platform.feedback.items.tags.add WRITE platform.write, admin surveys route_inferred None Feedback Items Tags Add
platform.feedback.items.tags.remove WRITE platform.write, admin surveys route_inferred None Feedback Items Tags Remove
platform.feedback.list READ platform.read, admin surveys route_inferred None Feedback List
platform.feedback.reconciliation READ platform.read, admin surveys declared_dynamic None Feedback Reconciliation
platform.feedback.sources.health READ platform.read, admin surveys declared_dynamic None Feedback Sources Health
platform.feedback.sources.list READ platform.read, admin surveys declared_dynamic None Feedback Sources List
platform.feedback.sources.rebuild WRITE platform.write, admin surveys route_inferred None Feedback Sources Rebuild
platform.feedback.sources.replay WRITE platform.write, admin surveys route_inferred None Feedback Sources Replay
platform.feedback.stats READ platform.read, admin surveys declared_dynamic None Feedback Stats
platform.fx.refresh.now WRITE platform.write, admin Any plan declared_dynamic None Fx Refresh Now
platform.geoip.autodetect READ platform.read, admin Any plan declared_dynamic None Geoip Autodetect
platform.get.admin.chat.history READ platform.read, admin Any plan declared_dynamic None Get Admin Chat History
platform.get.ai.snapshot WRITE platform.write, admin Any plan route_inferred None Get Ai Snapshot
platform.get.campaign.groups READ platform.read, admin Any plan declared_dynamic None Get Campaign Groups
platform.get.client.chat.knowledge.overview WRITE platform.write, admin Any plan declared_dynamic None Get Client Chat Knowledge Overview
platform.get.kb.categories READ platform.read, admin Any plan route_inferred None Get Kb Categories
platform.get.live.health.snapshot READ platform.read, admin Any plan route_inferred None Get Live Health Snapshot
platform.get.pwa.chat.prefs WRITE platform.write, admin Any plan declared_dynamic None Get Pwa Chat Prefs
platform.get.servers READ platform.read, admin Any plan declared_dynamic None Get Servers
platform.get.survey.config READ platform.read, admin Any plan declared_dynamic None Get Survey Config
platform.get.ticket.options READ platform.read, admin Any plan declared_dynamic None Get Ticket Options
platform.get.ticket.thread READ platform.read, admin Any plan route_inferred None Get Ticket Thread
platform.get.todo.list READ platform.read, admin Any plan declared_dynamic None Get Todo List
platform.get.whmcs.health.snapshot READ platform.read, admin Any plan declared_dynamic None Get Whmcs Health Snapshot
platform.get.widget.advanced READ platform.read, admin Any plan route_inferred None Get Widget Advanced
platform.groups.create WRITE platform.write, admin Any plan route_inferred None Groups Create
platform.groups.delete WRITE platform.write, admin Any plan route_inferred None Groups Delete
platform.groups.list WRITE platform.write, admin Any plan route_inferred None Groups List
platform.groups.rename WRITE platform.write, admin Any plan route_inferred None Groups Rename
platform.groups.set.primary WRITE platform.write, admin Any plan route_inferred None Groups Set Primary
platform.heatmap READ platform.read, admin Any plan route_inferred None Heatmap
platform.inbound.activity.feed READ platform.read, admin Any plan route_inferred None Inbound Activity Feed
platform.inbound.endpoints.delete WRITE platform.write, admin Any plan route_inferred None Inbound Endpoints Delete
platform.inbound.endpoints.list READ platform.read, admin Any plan route_inferred None Inbound Endpoints List
platform.inbound.endpoints.save WRITE platform.write, admin Any plan route_inferred None Inbound Endpoints Save
platform.inbound.endpoints.test WRITE platform.write, admin Any plan route_inferred None Inbound Endpoints Test
platform.ip.classify READ platform.read, admin Any plan route_inferred None Ip Classify
platform.js.errors.clear.all WRITE platform.write, admin Any plan declared_dynamic None Js Errors Clear All
platform.js.errors.list READ platform.read, admin Any plan route_inferred None Js Errors List
platform.leads READ platform.read, admin lead_intelligence route_inferred None Leads
platform.license.delete WRITE platform.write, admin Any plan declared_dynamic None License Delete
platform.license.diagnostics READ platform.read, admin Any plan declared_dynamic None License Diagnostics
platform.license.force.check READ platform.read, admin Any plan declared_dynamic None License Force Check
platform.license.preflight READ platform.read, admin Any plan declared_dynamic None License Preflight
platform.license.save WRITE platform.write, admin Any plan route_inferred None License Save
platform.license.status READ platform.read, admin Any plan declared_dynamic None License Status
platform.license.verify.now WRITE platform.write, admin Any plan declared_dynamic None License Verify Now
platform.lifecycle.evaluate READ platform.read, admin crm_automation route_inferred None Lifecycle Evaluate
platform.lifecycle.rule.delete WRITE platform.write, admin crm_automation route_inferred None Lifecycle Rule Delete
platform.lifecycle.rule.list READ platform.read, admin crm_automation route_inferred None Lifecycle Rule List
platform.lifecycle.rule.save WRITE platform.write, admin crm_automation route_inferred None Lifecycle Rule Save
platform.list.assignable.sites READ platform.read, admin Any plan declared_dynamic None List Assignable Sites
platform.list.network.issues READ platform.read, admin Any plan declared_dynamic None List Network Issues
platform.list.sites READ platform.read, admin Any plan declared_dynamic None List Sites
platform.lookup.client.full READ platform.read, admin Any plan route_inferred None Lookup Client Full
platform.mark.feedback.read WRITE platform.write, admin Any plan route_inferred None Mark Feedback Read
platform.marketplace.local.install WRITE platform.write, admin Any plan route_inferred None Marketplace Local Install
platform.marketplace.local.uninstall WRITE platform.write, admin Any plan route_inferred None Marketplace Local Uninstall
platform.marketplace.session.get READ platform.read, admin Any plan declared_dynamic None Marketplace Session Get
platform.marketplace.session.set WRITE platform.write, admin Any plan route_inferred None Marketplace Session Set
platform.message.contact.locale WRITE platform.write, admin Any plan route_inferred None Message Contact Locale
platform.message.outbound.convert WRITE platform.write, admin Any plan route_inferred None Message Outbound Convert
platform.message.translate WRITE platform.write, admin Any plan route_inferred None Message Translate
platform.message.translation.delete WRITE platform.write, admin Any plan route_inferred None Message Translation Delete
platform.message.translation.save WRITE platform.write, admin Any plan route_inferred None Message Translation Save
platform.onboarding.action READ platform.read, admin Any plan declared_dynamic None Onboarding Action
platform.onboarding.readiness READ platform.read, admin Any plan declared_dynamic None Onboarding Readiness
platform.open.network.issue READ platform.read, admin Any plan declared_dynamic None Open Network Issue
platform.open.ticket READ platform.read, admin Any plan route_inferred None Open Ticket
platform.operator.text.translate WRITE platform.write, admin Any plan route_inferred None Operator Text Translate
platform.opsiq.backup.export WRITE platform.write, admin Any plan explicit None Download a full backup in one request (retired)
platform.opsiq.backup.import WRITE platform.write, admin Any plan route_inferred None Opsiq Backup Import
platform.outreach.campaign.delete WRITE platform.write, admin crm_outreach route_inferred None Outreach Campaign Delete
platform.outreach.campaign.list READ platform.read, admin crm_outreach route_inferred None Outreach Campaign List
platform.outreach.campaign.save WRITE platform.write, admin crm_outreach route_inferred None Outreach Campaign Save
platform.outreach.campaign.send WRITE platform.write, admin crm_outreach route_inferred None Outreach Campaign Send
platform.outreach.compose.send WRITE platform.write, admin crm_outreach route_inferred None Outreach Compose Send
platform.outreach.replies.list READ platform.read, admin crm_outreach route_inferred None Outreach Replies List
platform.outreach.reply.ai WRITE platform.write, admin crm_outreach route_inferred None Outreach Reply Ai
platform.outreach.reply.mark WRITE platform.write, admin crm_outreach route_inferred None Outreach Reply Mark
platform.outreach.reply.pref WRITE platform.write, admin crm_outreach route_inferred None Outreach Reply Pref
platform.outreach.reply.send WRITE platform.write, admin crm_outreach route_inferred None Outreach Reply Send
platform.outreach.reply.thread WRITE platform.write, admin crm_outreach route_inferred None Outreach Reply Thread
platform.outreach.template.delete WRITE platform.write, admin crm_outreach route_inferred None Outreach Template Delete
platform.outreach.template.list READ platform.read, admin crm_outreach route_inferred None Outreach Template List
platform.outreach.template.preview READ platform.read, admin crm_outreach route_inferred None Outreach Template Preview
platform.outreach.template.save WRITE platform.write, admin crm_outreach route_inferred None Outreach Template Save
platform.overview READ platform.read, admin Any plan declared_dynamic None Overview
platform.overview.hub.view READ platform.read, admin Any plan declared_dynamic None Overview Hub View
platform.overview.intelligence.graph READ platform.read, admin Any plan declared_dynamic None Overview Intelligence Graph
platform.pages READ platform.read, admin Any plan route_inferred None Pages
platform.paths.data READ platform.read, admin Any plan route_inferred None Paths Data
platform.profile.change.password WRITE platform.write, admin Any plan declared_dynamic None Profile Change Password
platform.profile.get READ platform.read, admin Any plan route_inferred None Profile Get
platform.profile.reward.claim WRITE platform.write, admin Any plan route_inferred None Profile Reward Claim
platform.profile.reward.claim.cancel WRITE platform.write, admin Any plan route_inferred None Profile Reward Claim Cancel
platform.profile.save WRITE platform.write, admin Any plan declared_dynamic None Profile Save
platform.profile.session.revoke WRITE platform.write, admin Any plan route_inferred None Profile Session Revoke
platform.profile.sessions.list READ platform.read, admin Any plan declared_dynamic None Profile Sessions List
platform.profile.sessions.revoke.others WRITE platform.write, admin Any plan declared_dynamic None Profile Sessions Revoke Others
platform.purge WRITE platform.write, admin Any plan route_inferred None Purge
platform.purge.all WRITE platform.write, admin Any plan route_inferred None Purge All
platform.realtime READ platform.read, admin Any plan route_inferred None Realtime
platform.realtime.test WRITE platform.write, admin Any plan route_inferred None Realtime Test
platform.retention.data READ platform.read, admin Any plan route_inferred None Retention Data
platform.routes.list READ admin Any plan explicit None List every registered OpsIQ operation
platform.routes.read READ admin Any plan explicit route Execute a registered read operation
platform.routes.write WRITE admin Any plan explicit route, idempotency_key Execute a registered write operation
platform.run.ai.analysis WRITE platform.write, admin Any plan route_inferred None Run Ai Analysis
platform.save.admin.chat.history WRITE platform.write, admin Any plan route_inferred None Save Admin Chat History
platform.save.pwa.chat.prefs WRITE platform.write, admin Any plan declared_dynamic None Save Pwa Chat Prefs
platform.save.survey.config WRITE platform.write, admin Any plan route_inferred None Save Survey Config
platform.save.widget.advanced WRITE platform.write, admin Any plan declared_dynamic None Save Widget Advanced
platform.scim.token.issue READ platform.read, admin Any plan route_inferred None Scim Token Issue
platform.scim.token.list READ platform.read, admin Any plan declared_dynamic None Scim Token List
platform.scim.token.revoke WRITE platform.write, admin Any plan route_inferred None Scim Token Revoke
platform.segment.delete WRITE platform.write, admin crm route_inferred None Segment Delete
platform.segment.list READ platform.read, admin crm route_inferred None Segment List
platform.segment.members READ platform.read, admin crm route_inferred None Segment Members
platform.segment.preview READ platform.read, admin crm route_inferred None Segment Preview
platform.segment.save WRITE platform.write, admin crm route_inferred None Segment Save
platform.segment.suggestion.accept WRITE platform.write, admin crm route_inferred None Segment Suggestion Accept
platform.segment.suggestion.dismiss WRITE platform.write, admin crm route_inferred None Segment Suggestion Dismiss
platform.segment.suggestion.list READ platform.read, admin crm route_inferred None Segment Suggestion List
platform.send.campaign WRITE platform.write, admin Any plan route_inferred None Send Campaign
platform.send.client.email WRITE platform.write, admin Any plan route_inferred None Send Client Email
platform.send.ticket.reply WRITE platform.write, admin Any plan route_inferred None Send Ticket Reply
platform.service.studio.get READ platform.read, admin Any plan declared_dynamic None Service Studio Get
platform.set.active.site WRITE platform.write, admin Any plan route_inferred None Set Active Site
platform.site.set.group WRITE platform.write, admin Any plan route_inferred None Site Set Group
platform.sites.add WRITE platform.write, admin Any plan route_inferred None Sites Add
platform.sites.edit WRITE platform.write, admin Any plan route_inferred None Sites Edit
platform.sites.list WRITE platform.write, admin Any plan route_inferred None Sites List
platform.sites.picker WRITE platform.write, admin Any plan route_inferred None Sites Picker
platform.sites.remove WRITE platform.write, admin Any plan route_inferred None Sites Remove
platform.stats READ platform.read, admin Any plan declared_dynamic None Stats
platform.stepup.verify WRITE platform.write, admin Any plan declared_dynamic None Stepup Verify
platform.submit.agent.ai.feedback WRITE platform.write, admin Any plan route_inferred None Submit Agent Ai Feedback
platform.submit.triage.feedback WRITE platform.write, admin Any plan route_inferred None Submit Triage Feedback
platform.test.geoip READ platform.read, admin Any plan route_inferred None Test Geoip
platform.top.pages READ platform.read, admin Any plan route_inferred None Top Pages
platform.train.client.chat.knowledge WRITE platform.write, admin Any plan route_inferred None Train Client Chat Knowledge
platform.triggers READ platform.read, admin Any plan declared_dynamic None Triggers
platform.turn.pool.add WRITE platform.write, admin Any plan route_inferred None Turn Pool Add
platform.turn.pool.list READ platform.read, admin Any plan declared_dynamic None Turn Pool List
platform.turn.pool.pick.test WRITE platform.write, admin Any plan route_inferred None Turn Pool Pick Test
platform.turn.pool.remove WRITE platform.write, admin Any plan route_inferred None Turn Pool Remove
platform.turn.pool.update WRITE platform.write, admin Any plan route_inferred None Turn Pool Update
platform.update.lead.status WRITE platform.write, admin lead_intelligence route_inferred None Update Lead Status
platform.warehouse.export.run READ platform.read, admin Any plan declared_dynamic None Warehouse Export Run
platform.warehouse.exports.list READ platform.read, admin Any plan declared_dynamic None Warehouse Exports List
platform.webhook.deliveries.list READ platform.read, admin webhooks route_inferred None Webhook Deliveries List
platform.webhook.endpoint.delete WRITE platform.write, admin webhooks route_inferred None Webhook Endpoint Delete
platform.webhook.endpoint.list READ platform.read, admin webhooks declared_dynamic None Webhook Endpoint List
platform.webhook.endpoint.save WRITE platform.write, admin webhooks route_inferred None Webhook Endpoint Save
platform.webhook.endpoint.test READ platform.read, admin webhooks route_inferred None Webhook Endpoint Test
platform.weekly.digest.view READ platform.read, admin Any plan route_inferred None Weekly Digest View
platform.whmcs.op.dispatch READ platform.read, admin Any plan declared_dynamic None Whmcs Op Dispatch
platform.writing.json.knowledge.clear WRITE platform.write, admin Any plan declared_dynamic None Writing Json Knowledge Clear
platform.writing.json.knowledge.count READ platform.read, admin Any plan declared_dynamic None Writing Json Knowledge Count
platform.writing.json.knowledge.import WRITE platform.write, admin Any plan route_inferred None Writing Json Knowledge Import
portal_studio — 87 actions
ActionKindScopePlan featureContractRequired fieldsSummary
portal_studio.add WRITE portal_studio.write, admin Any plan route_inferred None Portal Domain Add
portal_studio.allocate WRITE portal_studio.write, admin Any plan route_inferred None Portal Subdomain Allocate
portal_studio.apply.theme WRITE portal_studio.write, admin Any plan route_inferred None Portal Design Apply Theme
portal_studio.approval WRITE portal_studio.write, admin Any plan route_inferred None Portal Design Approval
portal_studio.ask WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio Ask
portal_studio.brand.generate WRITE portal_studio.write, admin Any plan route_inferred None Portal Design Brand Generate
portal_studio.brand.import WRITE portal_studio.write, admin Any plan route_inferred None Portal Design Brand Import
portal_studio.cancel.schedule WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Design Cancel Schedule
portal_studio.check READ portal_studio.read, admin Any plan route_inferred None Portal Host Check
portal_studio.check.route.portal.subdomain.check READ portal_studio.read, admin Any plan route_inferred None Portal Subdomain Check
portal_studio.config READ portal_studio.read, admin Any plan declared_dynamic None Portal Handoff Config
portal_studio.delete.theme WRITE portal_studio.write, admin Any plan route_inferred None Portal Design Delete Theme
portal_studio.list READ portal_studio.read, admin Any plan declared_dynamic None Portal Domain List
portal_studio.load READ portal_studio.read, admin Any plan route_inferred None Portal Analytics Load
portal_studio.load.route.portal.design.load WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Design Load
portal_studio.load.route.portal.form.load READ portal_studio.read, admin Any plan declared_dynamic None Portal Form Load
portal_studio.preview WRITE portal_studio.write, admin Any plan route_inferred None Portal Design Preview
portal_studio.publish WRITE portal_studio.write, admin Any plan route_inferred None Portal Design Publish
portal_studio.remove WRITE portal_studio.write, admin Any plan route_inferred None Portal Domain Remove
portal_studio.revert WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Design Revert
portal_studio.rollback WRITE portal_studio.write, admin Any plan route_inferred None Portal Design Rollback
portal_studio.save WRITE portal_studio.write, admin Any plan route_inferred None Portal Design Save
portal_studio.save.route.portal.form.save WRITE portal_studio.write, admin Any plan route_inferred None Portal Form Save
portal_studio.save.theme WRITE portal_studio.write, admin Any plan route_inferred None Portal Design Save Theme
portal_studio.schedule READ portal_studio.read, admin Any plan route_inferred None Portal Design Schedule
portal_studio.test.link WRITE portal_studio.write, admin Any plan route_inferred None Portal Handoff Test Link
portal_studio.upload WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Image Upload
portal_studio.v2.apply.kit WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Apply Kit
portal_studio.v2.approve WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Approve
portal_studio.v2.certify READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Certify
portal_studio.v2.comment.add WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Comment Add
portal_studio.v2.comment.resolve WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Comment Resolve
portal_studio.v2.component.package.inspect READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Component Package Inspect
portal_studio.v2.component.package.install WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Component Package Install
portal_studio.v2.component.validate READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Component Validate
portal_studio.v2.data.resolve WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Data Resolve
portal_studio.v2.form.delete WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Form Delete
portal_studio.v2.form.evaluate READ portal_studio.read, admin Any plan route_inferred None Portal Studio V2 Form Evaluate
portal_studio.v2.form.save WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Form Save
portal_studio.v2.identity.discover READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Identity Discover
portal_studio.v2.identity.load READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Identity Load
portal_studio.v2.identity.save WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Identity Save
portal_studio.v2.knowledge.summary READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Knowledge Summary
portal_studio.v2.load READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Load
portal_studio.v2.lock READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Lock
portal_studio.v2.migration.apply WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Migration Apply
portal_studio.v2.migration.approve WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Migration Approve
portal_studio.v2.migration.list READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Migration List
portal_studio.v2.migration.reconcile READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Migration Reconcile
portal_studio.v2.migration.report WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Migration Report
portal_studio.v2.migration.rollback WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Migration Rollback
portal_studio.v2.migration.rollout READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Migration Rollout
portal_studio.v2.migration.start WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Migration Start
portal_studio.v2.node.add WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Node Add
portal_studio.v2.node.delete WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Node Delete
portal_studio.v2.node.duplicate WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Node Duplicate
portal_studio.v2.node.move WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Node Move
portal_studio.v2.node.update WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Node Update
portal_studio.v2.operations.control READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Operations Control
portal_studio.v2.operations.record WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Operations Record
portal_studio.v2.operations.summary READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Operations Summary
portal_studio.v2.org.context READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Org Context
portal_studio.v2.org.member.save WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Org Member Save
portal_studio.v2.org.members READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Org Members
portal_studio.v2.org.requests READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Org Requests
portal_studio.v2.page.create WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Page Create
portal_studio.v2.page.delete WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Page Delete
portal_studio.v2.page.duplicate WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Page Duplicate
portal_studio.v2.page.update WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Page Update
portal_studio.v2.parity.accept READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Parity Accept
portal_studio.v2.parity.capture READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Parity Capture
portal_studio.v2.parity.compare READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Parity Compare
portal_studio.v2.parity.create WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Parity Create
portal_studio.v2.parity.list READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Parity List
portal_studio.v2.presence READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Presence
portal_studio.v2.preview.catalog READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Preview Catalog
portal_studio.v2.publish WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Publish
portal_studio.v2.redirect.delete WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Redirect Delete
portal_studio.v2.redirect.save WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Redirect Save
portal_studio.v2.request.changes READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Request Changes
portal_studio.v2.review READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Review
portal_studio.v2.rollback WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Rollback
portal_studio.v2.save WRITE portal_studio.write, admin Any plan route_inferred None Portal Studio V2 Save
portal_studio.v2.schedule READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Schedule
portal_studio.v2.schedule.cancel WRITE portal_studio.write, admin Any plan declared_dynamic None Portal Studio V2 Schedule Cancel
portal_studio.v2.scim.config READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Scim Config
portal_studio.v2.unlock READ portal_studio.read, admin Any plan declared_dynamic None Portal Studio V2 Unlock
sales — 14 actions
ActionKindScopePlan featureContractRequired fieldsSummary
sales.ai.insight WRITE sales.write, admin sales_bridge route_inferred None Sales Ai Insight
sales.analyze WRITE sales.write, analytics.write, admin sales_bridge explicit None Analyze sales with AI
sales.chart WRITE sales.write, admin sales_bridge route_inferred None Sales Chart
sales.compare READ sales.read, analytics.read, admin sales_bridge explicit None Compare sales periods
sales.compare.route.sales.compare READ sales.read, admin sales_bridge route_inferred None Sales Compare
sales.goal.delete WRITE sales.write, admin crm_automation route_inferred None Conversion Goal Delete
sales.goal.list READ sales.read, admin crm_automation route_inferred None Conversion Goal List
sales.goal.save WRITE sales.write, admin crm_automation route_inferred None Conversion Goal Save
sales.list READ sales.read, analytics.read, admin sales_bridge explicit None List sales and conversions
sales.list.route.conversion.list READ sales.read, admin sales_bridge route_inferred None Conversion List
sales.record WRITE sales.write, admin sales_bridge route_inferred None Conversion Record
sales.stats READ sales.read, analytics.read, admin sales_bridge explicit None Read sales statistics
sales.stats.route.sales.stats READ sales.read, admin sales_bridge declared_dynamic None Sales Stats
sales.table READ sales.read, admin sales_bridge route_inferred None Sales Table
security — 20 actions
ActionKindScopePlan featureContractRequired fieldsSummary
security.ai.analyze WRITE security.write, admin security route_inferred None Security Ai Analyze
security.ai.ask WRITE security.write, admin security route_inferred None Security Ai Ask
security.ai.briefs READ security.read, admin security declared_dynamic None Security Ai Briefs
security.ai.chain.explain READ security.read, admin security route_inferred None Security Ai Chain Explain
security.ai.incidents READ security.read, admin security route_inferred None Security Ai Incidents
security.ai.js.triage READ security.read, admin security route_inferred None Security Ai Js Triage
security.ai.policies READ security.read, admin security declared_dynamic None Security Ai Policies
security.ai.policy.action READ security.read, admin security route_inferred None Security Ai Policy Action
security.ai.verdicts READ security.read, admin security route_inferred None Security Ai Verdicts
security.blocklist.add WRITE security.write, admin security explicit kind, value Add a spam rule (email, domain or IP) to the ticket blocklist
security.blocklist.list READ security.read, admin security explicit None List the current ticket spam rules
security.chain.reanchor WRITE security.write, admin security declared_dynamic None Security Chain Reanchor
security.check READ security.read, admin security explicit None Check an IP or email against the platform blocklists and Security AI verdicts
security.ip WRITE security.write, admin security route_inferred None Block Ip
security.ip.route.unblock.ip WRITE security.write, admin security route_inferred None Unblock Ip
security.list WRITE security.write, admin security route_inferred None Access Log List
security.overview.chains READ security.read, admin security declared_dynamic None Security Overview Chains
security.overview.data READ security.read, admin security declared_dynamic None Security Overview Data
security.report WRITE security.write, admin security explicit None Report abuse a connector observed (spam, login attack, scan, fraud)
security.visitor WRITE security.write, admin security route_inferred None Block Visitor
sessions — 5 actions
ActionKindScopePlan featureContractRequired fieldsSummary
sessions.detail READ sessions.read, admin tracking route_inferred None Session Detail
sessions.get READ sessions.read, analytics.read, admin tracking explicit session_id Get a session journey
sessions.list READ sessions.read, analytics.read, admin tracking explicit None List sessions
sessions.merged READ sessions.read, admin tracking route_inferred None Sessions Merged
sessions.table READ sessions.read, admin tracking route_inferred None Sessions Table
settings — 11 actions
ActionKindScopePlan featureContractRequired fieldsSummary
settings.ai.eval.watchtower.config WRITE settings.write, admin Any plan declared_dynamic None Ai Eval Watchtower Config
settings.get.client.chat.settings READ settings.read, admin Any plan route_inferred None Get Client Chat Settings
settings.get.settings READ settings.read, admin Any plan route_inferred None Get Settings
settings.opsiq.branding.clear WRITE settings.write, admin Any plan route_inferred None Opsiq Branding Clear
settings.opsiq.branding.upload WRITE settings.write, admin Any plan route_inferred None Opsiq Branding Upload
settings.privacy.settings.get READ settings.read, admin Any plan declared_dynamic None Privacy Settings Get
settings.privacy.settings.save WRITE settings.write, admin Any plan route_inferred None Privacy Settings Save
settings.save.ai.settings WRITE settings.write, admin Any plan route_inferred None Save Ai Settings
settings.save.chat.widget.settings WRITE settings.write, admin Any plan declared_dynamic None Save Chat Widget Settings
settings.save.client.chat.settings WRITE settings.write, admin Any plan route_inferred None Save Client Chat Settings
settings.save.settings WRITE settings.write, admin Any plan route_inferred None Save Settings
site_intelligence — 220 actions
ActionKindScopePlan featureContractRequired fieldsSummary
site_intelligence.action.audit.chain WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Action Audit Chain
site_intelligence.action.execute WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Action Execute
site_intelligence.action.preview WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Action Preview
site_intelligence.action.token WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Action Token
site_intelligence.agent.auto.bg WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Auto Bg
site_intelligence.agent.auto.bg.stop WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Auto Bg Stop
site_intelligence.agent.auto.step WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Auto Step
site_intelligence.agent.chat WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Chat
site_intelligence.agent.conn.delete WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Conn Delete
site_intelligence.agent.conn.get WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Conn Get
site_intelligence.agent.conn.save WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Conn Save
site_intelligence.agent.conn.test WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Conn Test
site_intelligence.agent.coverage WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Coverage
site_intelligence.agent.events WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Events
site_intelligence.agent.hosted.apply WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Hosted Apply
site_intelligence.agent.hosted.finalize WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Hosted Finalize
site_intelligence.agent.hosted.live.set WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Hosted Live Set
site_intelligence.agent.hosted.preview WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Hosted Preview
site_intelligence.agent.hosted.rollback WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Hosted Rollback
site_intelligence.agent.hosted.start WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Hosted Start
site_intelligence.agent.hosted.verify WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Hosted Verify
site_intelligence.agent.run.delete WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Run Delete
site_intelligence.agent.run.finalize WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Run Finalize
site_intelligence.agent.run.rollback WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Run Rollback
site_intelligence.agent.run.start WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Run Start
site_intelligence.agent.run.status WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Run Status
site_intelligence.agent.run.verify WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Run Verify
site_intelligence.agent.runs.list WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Runs List
site_intelligence.agent.set.mode WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Set Mode
site_intelligence.agent.status WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Status
site_intelligence.agent.step.apply WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Step Apply
site_intelligence.agent.step.skip WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Step Skip
site_intelligence.agent.turn.status WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Agent Turn Status
site_intelligence.ai.activity READ site_intelligence.read, admin site_intelligence declared_dynamic None Si Ai Activity
site_intelligence.ai.alert.enrich WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Alert Enrich
site_intelligence.ai.alerts WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Alerts
site_intelligence.ai.analyst WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Analyst
site_intelligence.ai.analyst.ask WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Analyst Ask
site_intelligence.ai.analyst.email WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Analyst Email
site_intelligence.ai.analyst.run WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Analyst Run
site_intelligence.ai.badges WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Badges
site_intelligence.ai.badges.portfolio READ site_intelligence.read, admin site_intelligence declared_dynamic None Si Ai Badges Portfolio
site_intelligence.ai.badges.preview WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Badges Preview
site_intelligence.ai.bl.plan WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Bl Plan
site_intelligence.ai.bl.plan.run WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Bl Plan Run
site_intelligence.ai.brief WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Brief
site_intelligence.ai.brief.run WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Brief Run
site_intelligence.ai.comp.analyse WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Comp Analyse
site_intelligence.ai.comp.analyse.run WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Comp Analyse Run
site_intelligence.ai.content.get WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Content Get
site_intelligence.ai.content.list WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Content List
site_intelligence.ai.content.publish WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Content Publish
site_intelligence.ai.content.write WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Content Write
site_intelligence.ai.daily.digest WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Daily Digest
site_intelligence.ai.discover WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Discover
site_intelligence.ai.fix.apply WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Fix Apply
site_intelligence.ai.fix.apply.bulk WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Fix Apply Bulk
site_intelligence.ai.fix.dismiss WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Fix Dismiss
site_intelligence.ai.fix.dismiss.bulk WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Fix Dismiss Bulk
site_intelligence.ai.fix.generate WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Fix Generate
site_intelligence.ai.fix.generate.all WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Fix Generate All
site_intelligence.ai.fix.list WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Fix List
site_intelligence.ai.kw.coach WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Kw Coach
site_intelligence.ai.kw.coach.run WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Kw Coach Run
site_intelligence.ai.overview WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Overview
site_intelligence.ai.page.audit WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Page Audit
site_intelligence.ai.page.audit.run WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Page Audit Run
site_intelligence.ai.portfolio READ site_intelligence.read, admin site_intelligence declared_dynamic None Si Ai Portfolio
site_intelligence.ai.portfolio.history READ site_intelligence.read, admin site_intelligence route_inferred None Si Ai Portfolio History
site_intelligence.ai.portfolio.run WRITE site_intelligence.write, admin site_intelligence declared_dynamic None Si Ai Portfolio Run
site_intelligence.ai.probe WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Probe
site_intelligence.ai.prompt.add WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Prompt Add
site_intelligence.ai.prompt.history WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Prompt History
site_intelligence.ai.prompt.remove WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Prompt Remove
site_intelligence.ai.prompts WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Prompts
site_intelligence.ai.readiness WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Readiness
site_intelligence.ai.ready WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ai Ready
site_intelligence.alert.resolve WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Alert Resolve
site_intelligence.alerts READ site_intelligence.read, admin site_intelligence route_inferred None Si Alerts
site_intelligence.alerts.list READ site_intelligence.read, admin site_intelligence explicit None List Site Intelligence alerts
site_intelligence.alerts.resolve WRITE site_intelligence.write, admin site_intelligence explicit alert_id Resolve a Site Intelligence alert
site_intelligence.analyze WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Analyze
site_intelligence.ask WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ask
site_intelligence.audit.hint WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Audit Hint
site_intelligence.backlink.disavow WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Backlink Disavow
site_intelligence.backlinks READ site_intelligence.read, admin site_intelligence route_inferred None Si Backlinks
site_intelligence.backlinks.list READ site_intelligence.read, admin site_intelligence explicit None List backlinks
site_intelligence.backlinks.refresh WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Backlinks Refresh
site_intelligence.brand.get WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Brand Get
site_intelligence.brand.radar WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Brand Radar
site_intelligence.brand.save WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Brand Save
site_intelligence.cannibalisation WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Cannibalisation
site_intelligence.compare WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Compare
site_intelligence.competitor.add WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Competitor Add
site_intelligence.competitor.refresh WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Competitor Refresh
site_intelligence.competitor.remove WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Competitor Remove
site_intelligence.competitors READ site_intelligence.read, admin site_intelligence route_inferred None Si Competitors
site_intelligence.competitors.list READ site_intelligence.read, admin site_intelligence explicit None List competitors
site_intelligence.content.brief WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Content Brief
site_intelligence.content.decay WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Content Decay
site_intelligence.content.draft WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Content Draft
site_intelligence.crawl.budget WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Crawl Budget
site_intelligence.crawl.list READ site_intelligence.read, admin site_intelligence route_inferred None Si Crawl List
site_intelligence.crawl.status READ site_intelligence.read, admin site_intelligence route_inferred None Si Crawl Status
site_intelligence.crawls.list READ site_intelligence.read, admin site_intelligence explicit None List Site Intelligence crawls
site_intelligence.crawls.status READ site_intelligence.read, admin site_intelligence explicit None Get crawl status
site_intelligence.dashboard READ site_intelligence.read, admin site_intelligence explicit None Read the Site Intelligence dashboard
site_intelligence.dashboard.route.si.dashboard READ site_intelligence.read, admin site_intelligence route_inferred None Si Dashboard
site_intelligence.dashboard.save WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Dashboard Save
site_intelligence.diag.backfill WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Diag Backfill
site_intelligence.diag.compare WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Diag Compare
site_intelligence.diag.portfolio READ site_intelligence.read, admin site_intelligence declared_dynamic None Si Diag Portfolio
site_intelligence.diag.recs.regen WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Diag Recs Regen
site_intelligence.diag.thresholds WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Diag Thresholds
site_intelligence.diag.thresholds.eval WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Diag Thresholds Eval
site_intelligence.diag.thresholds.history WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Diag Thresholds History
site_intelligence.diag.thresholds.profile WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Diag Thresholds Profile
site_intelligence.diag.thresholds.save WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Diag Thresholds Save
site_intelligence.diagnostics WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Diagnostics
site_intelligence.exec.report WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Exec Report
site_intelligence.export WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Export
site_intelligence.ga4.connect WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ga4 Connect
site_intelligence.ga4.list.properties WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ga4 List Properties
site_intelligence.ga4.map WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ga4 Map
site_intelligence.ga4.status WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ga4 Status
site_intelligence.ga4.sync WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Ga4 Sync
site_intelligence.gbp WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp
site_intelligence.gbp.draft.approve WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Draft Approve
site_intelligence.gbp.draft.dismiss WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Draft Dismiss
site_intelligence.gbp.draft.sync WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Draft Sync
site_intelligence.gbp.drafts WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Drafts
site_intelligence.gbp.locations READ site_intelligence.read, admin site_intelligence declared_dynamic None Si Gbp Locations
site_intelligence.gbp.map WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Map
site_intelligence.gbp.post.draft WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Post Draft
site_intelligence.gbp.post.publish WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Post Publish
site_intelligence.gbp.qa WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Qa
site_intelligence.gbp.qa.approve WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Qa Approve
site_intelligence.gbp.qa.dismiss WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Qa Dismiss
site_intelligence.gbp.qa.sync WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Qa Sync
site_intelligence.gbp.site.prefs WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Site Prefs
site_intelligence.gbp.sync WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gbp Sync
site_intelligence.google.truth.schedule.save WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Google Truth Schedule Save
site_intelligence.growth WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Growth
site_intelligence.gsc.connect WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gsc Connect
site_intelligence.gsc.list.properties WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gsc List Properties
site_intelligence.gsc.map WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gsc Map
site_intelligence.gsc.opportunities WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gsc Opportunities
site_intelligence.gsc.status WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gsc Status
site_intelligence.gsc.sync WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Gsc Sync
site_intelligence.image.audit WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Image Audit
site_intelligence.internal.links WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Internal Links
site_intelligence.issue.history WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Issue History
site_intelligence.issues READ site_intelligence.read, admin site_intelligence route_inferred None Si Issues
site_intelligence.issues.list READ site_intelligence.read, admin site_intelligence explicit None List Site Intelligence issues
site_intelligence.keyword.add WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Keyword Add
site_intelligence.keyword.remove WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Keyword Remove
site_intelligence.keyword.research WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Keyword Research
site_intelligence.keywords READ site_intelligence.read, admin site_intelligence route_inferred None Si Keywords
site_intelligence.keywords.list READ site_intelligence.read, admin site_intelligence explicit None List tracked keywords
site_intelligence.local WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Local
site_intelligence.local.grid WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Local Grid
site_intelligence.local.grid.scan WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Local Grid Scan
site_intelligence.log.ingest WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Log Ingest
site_intelligence.log.summary WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Log Summary
site_intelligence.metadata.audit WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Metadata Audit
site_intelligence.overview READ site_intelligence.read, admin site_intelligence declared_dynamic None Si Overview
site_intelligence.page WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Page
site_intelligence.page.experience WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Page Experience
site_intelligence.page.optimize WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Page Optimize
site_intelligence.pages READ site_intelligence.read, admin site_intelligence route_inferred None Si Pages
site_intelligence.pages.list READ site_intelligence.read, admin site_intelligence explicit None List Site Intelligence pages
site_intelligence.pagespeed.bridge.status WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Pagespeed Bridge Status
site_intelligence.portfolio.export WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Portfolio Export
site_intelligence.provider.health WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Provider Health
site_intelligence.rank.check WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Rank Check
site_intelligence.rec.action WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Rec Action
site_intelligence.recommendations WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Recommendations
site_intelligence.redirect.audit WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Redirect Audit
site_intelligence.report WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Report
site_intelligence.report.generate WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Report Generate
site_intelligence.reports WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Reports
site_intelligence.reports.list READ site_intelligence.read, admin site_intelligence source_inferred None Site Intelligence Reports List
site_intelligence.reset.google.oauth WRITE site_intelligence.write, admin site_intelligence declared_dynamic None Si Reset Google Oauth
site_intelligence.revenue WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Revenue
site_intelligence.revenue.portfolio READ site_intelligence.read, admin site_intelligence declared_dynamic None Si Revenue Portfolio
site_intelligence.save.shared.google.oauth WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Save Shared Google Oauth
site_intelligence.scan.run WRITE site_intelligence.write, admin site_intelligence explicit None Start a Site Intelligence analysis
site_intelligence.schedule.delete WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Schedule Delete
site_intelligence.schedule.run.now WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Schedule Run Now
site_intelligence.schedule.save WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Schedule Save
site_intelligence.schedules.list WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Schedules List
site_intelligence.schema.audit WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Schema Audit
site_intelligence.server.engineer WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Server Engineer
site_intelligence.settings.save WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Settings Save
site_intelligence.sites.list READ site_intelligence.read, admin site_intelligence explicit None List Site Intelligence monitored sites
site_intelligence.speed WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Speed
site_intelligence.speed.progress WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Speed Progress
site_intelligence.speed.run WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Speed Run
site_intelligence.speed.v2 WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Speed V2
site_intelligence.speed.v2.build.task WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Speed V2 Build Task
site_intelligence.speed.v2.collect WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Speed V2 Collect
site_intelligence.speed.v2.read WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Speed V2 Read
site_intelligence.speed.v2.run WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Speed V2 Run
site_intelligence.start.crawl WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Start Crawl
site_intelligence.task.approve WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Task Approve
site_intelligence.task.assign WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Task Assign
site_intelligence.task.bulk.apply WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Task Bulk Apply
site_intelligence.task.bulk.assign WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Task Bulk Assign
site_intelligence.task.bulk.deadline WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Task Bulk Deadline
site_intelligence.task.bulk.dismiss WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Task Bulk Dismiss
site_intelligence.task.deadline WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Task Deadline
site_intelligence.task.note WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Task Note
site_intelligence.task.proof WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Task Proof
site_intelligence.task.reject WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Task Reject
site_intelligence.task.review WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Task Review
site_intelligence.topical.map WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Topical Map
site_intelligence.webhook.delete WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Webhook Delete
site_intelligence.webhook.save WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Webhook Save
site_intelligence.webhooks.list WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Webhooks List
site_intelligence.workflow WRITE site_intelligence.write, admin site_intelligence route_inferred None Si Workflow
status — 6 actions
ActionKindScopePlan featureContractRequired fieldsSummary
status.component.save WRITE status.write, admin Any plan declared_dynamic None Status Component Save
status.components.save WRITE status.write, admin Any plan explicit name Create or update a public status component
status.incident.create WRITE status.write, admin Any plan declared_dynamic None Status Incident Create
status.incident.resolve READ status.read, admin Any plan route_inferred None Status Incident Resolve
status.incidents.create WRITE status.write, admin Any plan explicit title Create a status-page incident
status.incidents.resolve WRITE status.write, admin Any plan source_inferred None Status Incidents Resolve
surveys — 22 actions
ActionKindScopePlan featureContractRequired fieldsSummary
surveys.analytics.get READ surveys.read, admin surveys compatibility None Surveys Analytics Get
surveys.audiences.list READ surveys.read, admin surveys compatibility None Surveys Audiences List
surveys.audiences.materialize WRITE surveys.write, admin surveys compatibility None Surveys Audiences Materialize
surveys.campaigns.create WRITE surveys.write, admin surveys compatibility None Surveys Campaigns Create
surveys.campaigns.launch WRITE surveys.write, admin surveys compatibility None Surveys Campaigns Launch
surveys.campaigns.list READ surveys.read, admin surveys compatibility None Surveys Campaigns List
surveys.deployments.list READ surveys.read, admin surveys compatibility None Surveys Deployments List
surveys.deployments.set_status WRITE surveys.write, admin surveys compatibility None Surveys Deployments Set Status
surveys.get READ surveys.read, admin surveys compatibility None Surveys Get
surveys.imports.create WRITE surveys.write, admin surveys compatibility None Surveys Imports Create
surveys.imports.process WRITE surveys.write, admin surveys compatibility None Surveys Imports Process
surveys.invitations.list READ surveys.read, admin surveys compatibility None Surveys Invitations List
surveys.links.create WRITE surveys.write, admin surveys compatibility None Surveys Links Create
surveys.list READ surveys.read, admin surveys compatibility None Surveys List
surveys.responses.get READ surveys.read, admin surveys compatibility None Surveys Responses Get
surveys.responses.list READ surveys.read, admin surveys compatibility None Surveys Responses List
surveys.triggers.list READ surveys.read, admin surveys compatibility None Surveys Triggers List
surveys.types.list READ surveys.read, admin surveys compatibility None Surveys Types List
surveys.versions.list READ surveys.read, admin surveys compatibility None Surveys Versions List
surveys.webhooks.delete WRITE surveys.write, admin surveys compatibility None Surveys Webhooks Delete
surveys.webhooks.list READ surveys.read, admin surveys compatibility None Surveys Webhooks List
surveys.webhooks.save WRITE surveys.write, admin surveys compatibility None Surveys Webhooks Save
team — 28 actions
ActionKindScopePlan featureContractRequired fieldsSummary
team.delete WRITE team.write, admin Any plan route_inferred None Admin Users Delete
team.delete.route.departments.delete WRITE team.write, admin Any plan route_inferred None Departments Delete
team.list READ team.read, admin Any plan route_inferred None Admin Users List
team.list.route.departments.list READ team.read, admin Any plan declared_dynamic None Departments List
team.perf.activity WRITE team.write, admin Any plan route_inferred None Team Perf Activity
team.perf.ai.compare WRITE team.write, admin Any plan route_inferred None Team Perf Ai Compare
team.perf.ai.review WRITE team.write, admin Any plan route_inferred None Team Perf Ai Review
team.perf.availability WRITE team.write, admin Any plan route_inferred None Team Perf Availability
team.perf.claim.pay WRITE team.write, admin Any plan route_inferred None Team Perf Claim Pay
team.perf.claim.reject WRITE team.write, admin Any plan route_inferred None Team Perf Claim Reject
team.perf.clear WRITE team.write, admin Any plan route_inferred None Team Perf Clear
team.perf.data WRITE team.write, admin Any plan route_inferred None Team Perf Data
team.perf.heatmap WRITE team.write, admin Any plan route_inferred None Team Perf Heatmap
team.perf.history WRITE team.write, admin Any plan route_inferred None Team Perf History
team.perf.pay.all.claims WRITE team.write, admin Any plan route_inferred None Team Perf Pay All Claims
team.perf.reward.claims WRITE team.write, admin Any plan route_inferred None Team Perf Reward Claims
team.perf.reward.pay WRITE team.write, admin Any plan route_inferred None Team Perf Reward Pay
team.perf.reward.payouts WRITE team.write, admin Any plan route_inferred None Team Perf Reward Payouts
team.perf.reward.save WRITE team.write, admin Any plan route_inferred None Team Perf Reward Save
team.perf.reward.state WRITE team.write, admin Any plan route_inferred None Team Perf Reward State
team.perf.trends WRITE team.write, admin Any plan route_inferred None Team Perf Trends
team.perf.v2.data WRITE team.write, admin Any plan route_inferred None Team Perf V2 Data
team.perf.v2.export WRITE team.write, admin Any plan route_inferred None Team Perf V2 Export
team.perf.v2.live WRITE team.write, admin Any plan route_inferred None Team Perf V2 Live
team.perf.v2.settings WRITE team.write, admin Any plan route_inferred None Team Perf V2 Settings
team.perf.v2.settings.save WRITE team.write, admin Any plan route_inferred None Team Perf V2 Settings Save
team.save WRITE team.write, admin Any plan route_inferred None Admin Users Save
team.save.route.departments.save WRITE team.write, admin Any plan route_inferred None Departments Save
tickets — 75 actions
ActionKindScopePlan featureContractRequired fieldsSummary
tickets.ai.summary READ tickets.read, admin ticket_system route_inferred None Ticket Ai Summary
tickets.analytics READ tickets.read, admin ticket_system route_inferred None Ticket Analytics
tickets.approval.decide READ tickets.read, admin ticket_system route_inferred None Ticket Approval Decide
tickets.approval.request READ tickets.read, admin ticket_system route_inferred None Ticket Approval Request
tickets.approvals.pending READ tickets.read, admin ticket_system declared_dynamic None Ticket Approvals Pending
tickets.assignment.rule.delete WRITE tickets.write, admin ticket_system route_inferred None Ticket Assignment Rule Delete
tickets.assignment.rule.list READ tickets.read, admin ticket_system declared_dynamic None Ticket Assignment Rule List
tickets.assignment.rule.save WRITE tickets.write, admin ticket_system declared_dynamic None Ticket Assignment Rule Save
tickets.assignment_rules.delete WRITE tickets.write, admin ticket_system source_inferred None Tickets Assignment Rules Delete
tickets.assignment_rules.save WRITE tickets.write, admin ticket_system explicit name Create or update a ticket assignment rule
tickets.bulk WRITE tickets.write, admin ticket_system source_inferred None Tickets Bulk
tickets.bulk.route.tickets.bulk WRITE tickets.write, admin ticket_system route_inferred None Tickets Bulk
tickets.calendar.delete WRITE tickets.write, admin ticket_system route_inferred None Sla Calendar Delete
tickets.calendar.save WRITE tickets.write, admin ticket_system declared_dynamic None Sla Calendar Save
tickets.claim WRITE tickets.write, admin ticket_system route_inferred None Ticket Claim
tickets.embed.load WRITE tickets.write, admin ticket_system route_inferred None Ticket Embed Load
tickets.embed.save WRITE tickets.write, admin ticket_system route_inferred None Ticket Embed Save
tickets.embed.secret WRITE tickets.write, admin ticket_system route_inferred None Ticket Embed Secret
tickets.field.save WRITE tickets.write, admin ticket_system route_inferred None Ticket Field Save
tickets.follower.add WRITE tickets.write, admin ticket_system route_inferred None Ticket Follower Add
tickets.follower.remove WRITE tickets.write, admin ticket_system route_inferred None Ticket Follower Remove
tickets.get READ tickets.read, admin ticket_system source_inferred None Tickets Get
tickets.kb.deflection READ tickets.read, admin ticket_system route_inferred None Ticket Kb Deflection
tickets.kb.draft WRITE tickets.write, admin ticket_system route_inferred None Ticket Kb Draft
tickets.kb.save WRITE tickets.write, admin ticket_system route_inferred None Ticket Kb Save
tickets.kb.version.restore READ tickets.read, admin ticket_system route_inferred None Ticket Kb Version Restore
tickets.kb.versions READ tickets.read, admin ticket_system route_inferred None Ticket Kb Versions
tickets.link.add WRITE tickets.write, admin ticket_system route_inferred None Ticket Link Add
tickets.link.remove WRITE tickets.write, admin ticket_system route_inferred None Ticket Link Remove
tickets.list READ tickets.read, admin ticket_system source_inferred None Tickets List
tickets.open WRITE tickets.write, admin ticket_system source_inferred None Tickets Open
tickets.open_guest WRITE tickets.write, admin ticket_system source_inferred None Tickets Open Guest
tickets.ops.summary READ tickets.read, admin ticket_system declared_dynamic None Ticket Ops Summary
tickets.policy.delete WRITE tickets.write, admin ticket_system route_inferred None Sla Policy Delete
tickets.policy.list READ tickets.read, admin ticket_system declared_dynamic None Sla Policy List
tickets.policy.save WRITE tickets.write, admin ticket_system declared_dynamic None Sla Policy Save
tickets.presence.leave READ tickets.read, admin ticket_system route_inferred None Ticket Presence Leave
tickets.presence.ping READ tickets.read, admin ticket_system route_inferred None Ticket Presence Ping
tickets.quick.replies WRITE tickets.write, admin ticket_system declared_dynamic None Ticket Quick Replies
tickets.quick.reply.save WRITE tickets.write, admin ticket_system route_inferred None Ticket Quick Reply Save
tickets.relations.get READ tickets.read, admin ticket_system route_inferred None Ticket Relations Get
tickets.reply WRITE tickets.write, admin ticket_system source_inferred None Tickets Reply
tickets.reply.delete WRITE tickets.write, admin ticket_system route_inferred None Ticket Reply Delete
tickets.reply.edit WRITE tickets.write, admin ticket_system route_inferred None Ticket Reply Edit
tickets.reply.outbound.convert WRITE tickets.write, admin ticket_system route_inferred None Ticket Reply Outbound Convert
tickets.reply.translate WRITE tickets.write, admin ticket_system route_inferred None Ticket Reply Translate
tickets.reply.translation.delete WRITE tickets.write, admin ticket_system route_inferred None Ticket Reply Translation Delete
tickets.reply.translation.save WRITE tickets.write, admin ticket_system route_inferred None Ticket Reply Translation Save
tickets.rule.compose READ tickets.read, admin ticket_system route_inferred None Ticket Rule Compose
tickets.side.ai.draft WRITE tickets.write, admin ticket_system route_inferred None Ticket Side Ai Draft
tickets.side.assign.department WRITE tickets.write, admin ticket_system route_inferred None Ticket Side Assign Department
tickets.side.create WRITE tickets.write, admin ticket_system route_inferred None Ticket Side Create
tickets.side.list READ tickets.read, admin ticket_system route_inferred None Ticket Side List
tickets.side.mention READ tickets.read, admin ticket_system route_inferred None Ticket Side Mention
tickets.side.recipients READ tickets.read, admin ticket_system declared_dynamic None Ticket Side Recipients
tickets.side.reply WRITE tickets.write, admin ticket_system route_inferred None Ticket Side Reply
tickets.sla.delete WRITE tickets.write, admin ticket_system source_inferred None Tickets Sla Delete
tickets.sla.save WRITE tickets.write, admin ticket_system explicit name Create or update an SLA policy
tickets.split WRITE tickets.write, admin ticket_system route_inferred None Ticket Split
tickets.split.candidates WRITE tickets.write, admin ticket_system route_inferred None Ticket Split Candidates
tickets.tag.add WRITE tickets.write, admin ticket_system route_inferred None Ticket Tag Add
tickets.tag.list READ tickets.read, admin ticket_system route_inferred None Ticket Tag List
tickets.tag.remove WRITE tickets.write, admin ticket_system route_inferred None Ticket Tag Remove
tickets.tags.add WRITE tickets.write, admin ticket_system source_inferred None Tickets Tags Add
tickets.tags.list READ tickets.read, admin ticket_system source_inferred None Tickets Tags List
tickets.tags.remove WRITE tickets.write, admin ticket_system source_inferred None Tickets Tags Remove
tickets.update WRITE tickets.write, admin ticket_system explicit None Update a ticket status, priority, subject, department or assignment
tickets.view.delete WRITE tickets.write, admin ticket_system route_inferred None Ticket View Delete
tickets.view.list READ tickets.read, admin ticket_system declared_dynamic None Ticket View List
tickets.view.save WRITE tickets.write, admin ticket_system route_inferred None Ticket View Save
tickets.views.delete WRITE tickets.write, admin ticket_system source_inferred None Tickets Views Delete
tickets.views.save WRITE tickets.write, admin ticket_system source_inferred None Tickets Views Save
tickets.worklog.add WRITE tickets.write, admin ticket_system route_inferred None Ticket Worklog Add
tickets.worklog.delete WRITE tickets.write, admin ticket_system route_inferred None Ticket Worklog Delete
tickets.worklog.list READ tickets.read, admin ticket_system route_inferred None Ticket Worklog List
todos — 1 action
ActionKindScopePlan featureContractRequired fieldsSummary
todos.add WRITE todos.write, admin Any plan source_inferred None Todos Add
visitors — 3 actions
ActionKindScopePlan featureContractRequired fieldsSummary
visitors.block WRITE visitors.write, security.write, admin security explicit visitor_id Block a visitor
visitors.list READ visitors.read, analytics.read, admin tracking explicit None List visitors
visitors.table READ visitors.read, admin tracking route_inferred None Visitors Table
writing — 6 actions
ActionKindScopePlan featureContractRequired fieldsSummary
writing.analyze WRITE writing ai_writing source_inferred None Writing Analyze
writing.compose WRITE writing ai_writing source_inferred None Writing Compose
writing.reply WRITE writing ai_writing source_inferred None Writing Reply
writing.rewrite WRITE writing ai_writing source_inferred None Writing Rewrite
writing.summarize WRITE writing ai_writing source_inferred None Writing Summarize
writing.translate WRITE writing ai_writing source_inferred None Writing Translate

Deprecated compatibility bridge

platform.routes.list, platform.routes.read and platform.routes.write remain available for older administrator integrations, but they are deprecated. Every registered administrator JSON operation now has its own stable named action, scope, read/write classification, risk metadata and machine-readable contract. New integrations should call the named action shown in this directory.

Interactive browser callbacks, OAuth redirects, streams and binary downloads are not JSON actions and continue to use their dedicated endpoints.

Connector Contract 2.2

The runtime, Connector Builder, manifest validator, conformance tests, public documentation and in-app help consume this same versioned contract. A connector must declare what it supports rather than relying on undocumented method discovery.

Connector profiles

ProfilePurposeDefault capabilities
standard_api Standard REST or GraphQL API
Actions, triggers, OAuth/API-key authentication and optional context/identity mappings.		 actions, triggers, native_api, ai_brain_aware
commerce Commerce and billing platform
Customers, orders, sales, subscriptions, billing, promotions and journey events.		 actions, triggers, journey_events, sales, billing, sync_orders, customer_import, survey, promo_audience, promo_feed, context, identity
helpdesk Helpdesk and ticket platform
Inbound tickets, outbound replies/notes, customer roster, AI triage and bidirectional ticket mirroring.		 actions, triggers, inbound_ticket, outbound_reply, outbound_note, ai_tickets, customer_import, survey, context, identity, ticket_mirror, attachment_bridge, conflict_resolution
mailbox Mailbox and email provider
Inbound/outbound mail, address-book sync, multi-account OAuth and CRM timeline integration.		 inbound_email, outbound_email, mailbox, email_mailbox, oauth, actions, customer_import, ai_reply
site_intelligence Site Intelligence data provider
SEO, analytics, search-console, local-search or monitoring provider with scheduled sync.		 actions, triggers, site_intelligence, seo, scheduled_workers, durable_queue
saas_bridge SaaS bridge
Deep two-way SaaS integration with customers, billing, identity, tickets, webhooks, queues, attachments and workers.		 actions, triggers, webhook, context, identity, customer_import, survey, journey_events, sales, billing, inbound_ticket, outbound_reply, ticket_mirror, attachment_bridge, durable_queue, scheduled_workers, database_migrations, conflict_resolution, enterprise_hooks, admin_assets
local_php_platform Local PHP platform bridge
WHMCS-style local hooks, database access, two-way tickets, billing/customer sync, queues and migrations.		 actions, native_data, context, identity, customer_import, survey, journey_events, sales, billing, inbound_ticket, outbound_reply, ticket_mirror, attachment_bridge, durable_queue, scheduled_workers, database_migrations, conflict_resolution, enterprise_hooks, admin_assets

Capabilities

CapabilityVersionModeContractInterfacesRequired files
actions 1.0 generated Universal actions
Methods: registerActions		 actions.json
triggers 1.0 generated Inbound event triggers
Methods: handleWebhook		 actions.json
webhook 1.0 generated Inbound webhook endpoint
Methods: handleWebhook
journey_events 1.1 generated Universal Journey Event Contract mapping
 OpsIQ\Connectors\JourneyEventConnectorInterface settings.json
context 1.0 generated AI context providers
Methods: contextProviders		 OpsIQ\Connectors\ContextConnectorInterface ContextProvider.php
identity 1.0 generated Admin/customer identity providers
Methods: identityProviders, detectAdmin, detectCustomer		 OpsIQ\Connectors\IdentityConnectorInterface IdentityProvider.php
sales 1.1 generated Sales and revenue ingestion
 OpsIQ\Connectors\CommerceConnectorInterface SalesIngest.php
billing 1.0 generated Cross-platform billing snapshot
Methods: billingProviders		 OpsIQ\Connectors\BillingConnectorInterface BillingProvider.php
payments 1.0 generated Payment-provider capability bus
Methods: paymentsCapabilities
inbound_ticket 1.0 generated External ticket/email to OpsIQ ticket ingestion
Methods: handleWebhook		 OpsIQ\Connectors\TicketMirrorConnectorInterface
outbound_reply 1.0 generated Reply mirroring to the external platform
Methods: pushReply		 OpsIQ\Connectors\TicketMirrorConnectorInterface
sync_users 2.0 generated Staff/customer synchronisation
Methods: listCustomers		 OpsIQ\Connectors\CustomerImportConnectorInterface SyncImport.php
sync_departments 1.0 generated Department/team synchronisation
 SyncImport.php
sync_orders 1.0 declarative Order roster and order-event synchronisation
 OpsIQ\Connectors\CommerceConnectorInterface
sync_products 1.0 declarative Product, catalog and inventory synchronisation
Methods: registerActions
sync_projects 1.0 declarative Project, issue and workspace synchronisation
Methods: registerActions
customer_import 2.0 generated CRM customer roster import
Methods: listCustomers, backfillChunk		 OpsIQ\Connectors\CustomerImportConnectorInterface
security_events 1.1 generated Receive and emit security events
Methods: securityCapabilities, syncBlockedIp, removeBlockedIp		 OpsIQ\Connectors\SecuritySyncConnectorInterface
security_native_block 1.0 generated Native remote IP/CIDR blocking
Methods: syncBlockedIp, removeBlockedIp		 OpsIQ\Connectors\SecuritySyncConnectorInterface
survey 1.0 generated Survey identity, audiences, recipients and variables
Methods: surveyAudienceCatalog, surveyAudienceFacts, surveyVariableCatalog, surveyVariables, surveyRecipientPage		 OpsIQ\Connectors\SurveyConnectorInterface SurveyProvider.php
reply_feedback 1.0 generated Ticket reply feedback mirror (platform reply ratings land via the portal write method)
Methods: replyFeedbackCatalog, pullReplyFeedback		 OpsIQ\Connectors\ReplyFeedbackConnectorInterface
promo_audience 1.0 generated Promotion targeting facts
Methods: subscribers		 OpsIQ\Connectors\PromotionConnectorInterface
promo_feed 1.0 generated Promotion product/content feed
 OpsIQ\Connectors\PromotionConnectorInterface
email_mailbox 1.0 generated Mailbox bus, outbound mail and address-book sync
Methods: emailAccounts		 OpsIQ\Connectors\MailboxConnectorInterface
inbound_email 1.0 declarative Receive inbound email
Methods: poll, handleWebhook		 OpsIQ\Connectors\MailboxConnectorInterface
outbound_email 1.0 declarative Send outbound email
Methods: registerActions		 OpsIQ\Connectors\MailboxConnectorInterface
mailbox 1.0 declarative Mailbox connector
Methods: emailAccounts		 OpsIQ\Connectors\MailboxConnectorInterface
ai_tickets 1.0 generated AI triage and Inbox Copilot for remote tickets
Methods: loadTriageContext		 AiOperations.php
ai_reply 1.0 declarative AI-assisted reply drafting
Methods: registerActions
ai_brain_aware 1.0 generated Connector expertise supplied to Admin AI
 ai_expertise_admin.md, ai_api_reference.md
native_api 1.0 generated Native API passthrough
Methods: registerActions
native_data 1.0 declarative Local database/platform data adapter
Methods: nativeDataProviders		 OpsIQ\Connectors\NativeDataConnectorInterface
crm 1.0 declarative CRM capability provider (calendar, enrichment, telephony or customer data)
Methods: crmCapabilities		 OpsIQ\Connectors\CrmCapabilityConnectorInterface
block_registry 1.0 declarative Remote sender block-registry synchronisation
Methods: blockSender, unblockSender, isSenderBlocked		 OpsIQ\Platform\BlockRegistryInterface
inbound_comment 1.0 declarative Inbound comment ingestion
Methods: handleWebhook
outbound_note 1.0 declarative Outbound private note
Methods: registerActions
outbound_notification 1.0 declarative Outbound notification delivery
Methods: registerActions
oauth 1.0 generated OAuth 2.0 authorisation
reviews 1.0 declarative Review ingestion and response
Methods: registerActions
local 1.0 declarative Local search/location data
Methods: registerActions
seo 1.0 declarative SEO data and actions
Methods: registerActions
site_intelligence 1.0 declarative Site Intelligence provider
Methods: siteIntelligenceProviders		 OpsIQ\Connectors\SiteIntelligenceConnectorInterface
analytics 1.0 declarative Analytics data provider
Methods: analyticsCapabilities
comms 1.0 declarative Communications/video-meeting provider
Methods: commsCapabilities
admin_assets 1.0 generated Connector-provided admin/account/public browser assets
Methods: adminAssets		 OpsIQ\Connectors\AdminAssetConnectorInterface
enterprise_hooks 1.0 extension Platform-native hooks and lifecycle callbacks
 EnterpriseExtension.php
durable_queue 2.0 extension Durable outbox/inbox queue and retry policy
 EnterpriseExtension.php
ticket_mirror 2.0 extension Bidirectional ticket mirror with conflict handling
 OpsIQ\Connectors\TicketMirrorConnectorInterface EnterpriseExtension.php
attachment_bridge 2.0 extension Attachment upload/download transfer
 EnterpriseExtension.php
database_migrations 1.0 extension Connector-owned schema migrations
 EnterpriseExtension.php
scheduled_workers 1.0 extension Connector-owned scheduled/background workers
 EnterpriseExtension.php
conflict_resolution 1.0 extension Two-way sync conflict strategy
 EnterpriseExtension.php
Enterprise profiles: saas_bridge and local_php_platform generate an EnterpriseExtension.php scaffold for migrations, platform hooks, durable queues, scheduled workers, ticket mirroring, attachments and conflict resolution. Vendor-specific business rules are implemented inside those generated extension points.

Contacts

POST/api/v1.php

List contacts with action <code>crm.contacts.list</code>.

Scope: crm.read

curl -X POST https://your-opsiq-domain.com/api/v1.php \
  -H "Authorization: Bearer opq_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"action":"crm.contacts.list","q":"ada","limit":25}'
POST/api/v1.php

Create or update contacts with <code>crm.contacts.save</code> or <code>crm.contacts.upsert</code>.

Scope: crm.write

{
  "action": "crm.contacts.upsert",
  "email": "[email protected]",
  "name": "Ada Lovelace",
  "tags": ["trial", "developer"]
}
POST/api/v1.php

Fetch one contact with <code>crm.contacts.detail</code>, export with <code>crm.contacts.export</code>, or ask for next action with <code>crm.contacts.next_action</code>.

Scope: crm.read

Tickets

POST/api/v1.php

Open support tickets with action <code>tickets.open</code> or <code>tickets.open_guest</code>.

Scope: admin

{
  "action": "tickets.open",
  "customer_email": "[email protected]",
  "customer_name": "Example Customer",
  "subject": "Cannot activate account",
  "body": "Activation email never arrived.",
  "priority": "high"
}
POST/api/v1.php

Use ticket actions for tags, saved views, assignment rules, SLA policies, and bulk queue actions.

Scope: admin

{"action":"tickets.bulk","operation":"close","ids":[123,124]}
Ticket write actions are operator-side actions and require an API key with admin scope. For platform-native ticket sync, prefer the connector action gateway.

Security

The security contract lets any connector or integration consult OpsIQ's security intelligence and feed what it observes back in. Mint an API key with the security.read and security.write scopes.

POST/api/v1.php

Check an IP or email against the IP firewall, the ticket spam blocklist, and the cached Security AI verdict with <code>security.check</code>.

Scope: security.read

{
  "action": "security.check",
  "ip": "203.0.113.7",
  "email": "[email protected]"
}
POST/api/v1.php

Report abuse your system observed with <code>security.report</code>. The report is recorded as a security event, the IP is classified by the Security AI immediately, and admins are alerted when the verdict is high risk.

Scope: security.write

{
  "action": "security.report",
  "ip": "203.0.113.7",
  "kind": "spam",
  "reason": "Sent 40 junk tickets in 10 minutes",
  "source": "whmcs:example.com"
}
POST/api/v1.php

Manage spam rules with <code>security.blocklist.add</code> and read them with <code>security.blocklist.list</code>. These are the same rules the Tickets page "Block sender" control writes.

Scope: security.write

{
  "action": "security.blocklist.add",
  "kind": "domain",
  "value": "spam-sender.example",
  "reason": "Bulk junk tickets",
  "expires_hours": 720
}
Blocked mail is never destroyed: it still lands in the Spam view where it can be read and restored. The platform's own server IPs can never be blocked or reported through this API.

Chats

POST/api/v1.php

Manage operator chat resources such as saved replies with actions like <code>chat.saved_replies.list</code>, <code>chat.saved_replies.save</code>, and <code>chat.saved_replies.add</code>.

Scope: admin

For visitor live chat, use the widget runtime. The public action API is for server-side integrations and operator tooling.

Analytics

POST/api/v1.php

Read CRM and business activity through action catalog reads such as <code>crm.events.list</code>, <code>crm.conversions.list</code>, and <code>crm.deals.list</code>.

Scope: crm.read

curl -X POST https://your-opsiq-domain.com/api/v1.php \
  -H "Authorization: Bearer opq_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"action":"crm.events.list","limit":50}'

Responses are workspace-scoped. Shared site groups do not merge per-domain visitor data unless the called action explicitly supports that aggregation.

Proactive Events

POST/api/v1.php

Record lifecycle and conversion activity with action API calls such as <code>crm.activities.record</code>, <code>crm.conversions.record</code>, or lifecycle evaluation actions.

Scope: crm.write

{
  "action": "crm.activities.record",
  "email": "[email protected]",
  "event": "checkout.abandoned",
  "value": 129.50,
  "currency": "USD"
}

Use meta.actions to discover the currently enabled proactive and lifecycle actions on the install.

Knowledge Base

POST/api/v1.php

Read and manage FAQ/knowledge entries with <code>kb.faq.list</code>, <code>kb.faq.save</code>, <code>kb.faq.delete</code>, <code>kb.faq.generate</code>, and <code>kb.faq.import</code>.

Scope: admin/read

{
  "action": "kb.faq.save",
  "question": "How do I reset my password?",
  "answer": "Open Account Settings, choose Security, then Reset Password.",
  "status": "published"
}

The customer AI can use published knowledge-base content when answering visitors, depending on your AI instruction settings.

Widget And Identity

Install the OpsIQ widget on each website you want to track. Visitor data is collected per domain and stamped to the active site.

<script>
  window.OpsIQSettings = {
    siteKey: 'site_public_key',
    identity: {
      email: '[email protected]',
      name: 'Example Customer',
      external_id: 'cust_123'
    }
  };
</script>
<script src="https://your-opsiq-domain.com/widget.php" async></script>

Use identity when the visitor is logged in. For anonymous visitors, omit identity and OpsIQ will stitch later activity when the visitor identifies themselves.

Webhooks

Webhooks let other tools subscribe to OpsIQ activity. Register endpoints with crm.webhooks.save (or in the admin), then sign requests with the shared secret. The event names below come from the CRM event stream; call crm.events.catalog for the authoritative live list of subscribable events on your install. The same rows are also queryable by polling crm.events.list.

EventWhen it firesUseful for
crm.contact.createdA contact is created.CRM mirror / enrichment.
crm.contact.updatedA contact's fields change.Profile sync.
crm.deal.stage_changedA deal moves to a different stage.Pipeline automation.
crm.deal.created / crm.deal.won / crm.deal.lostA deal is created, marked won, or marked lost.Revenue reporting.
crm.task.createdA task is created.Workflow automation.
crm.outreach.replyAn outreach reply is classified.Sales alerting.
crm.agent.proposal_createdAn AI agent queues an Approve-Queue proposal.Human-in-the-loop review.

Also emitted: crm.company.created, crm.company.merged, crm.company.updated, crm.deal.updated.

{
  "event":"crm.contact.created",
  "event_id":"evt_123",
  "_workspace_key":"site_abc123",
  "contact_id":42
}

Connector SDK

Connectors are the production path for platform-specific actions. A connector defines metadata, settings, capability flags, and action specs. OpsIQ calls those actions through the gateway so validation, audit hooks, and platform sync stay consistent.

Manifest basics

{
  "slug":"example_platform",
  "name":"Example Platform",
  "version":"1.0.0",
  "manifest_version":1,
  "compatibility":{"opsiq_min":"1.0.0","opsiq_max":"*"},
  "capabilities":["native_api","tickets","customers"],
  "settings":[{"key":"api_key","type":"password","label":"API key"}]
}

Action shape

{
  "id":"ticket.reply",
  "label":"Reply to ticket",
  "params":{"ticket_id":"string","message":"string"},
  "requires_confirmation":true
}

Email connectors should expose mailbox/piping settings, not store or currency settings. Commerce connectors should expose order/customer/product actions. Support connectors should expose ticket, comment, assignment, and status actions.

Errors And Status Codes

StatusMeaningFix
400Invalid request body or parameter.Check JSON and required fields.
401Missing or invalid bearer token.Generate or rotate the API key.
403The API key does not have the required scope.Add the exact scope or use a more limited key per integration.
404Route or resource not found.Check the endpoint and id.
422Validation failed.Fix the field named in the error.
503A required service is unavailable.Check installation health and diagnostics.
 
{"success":false,"error":"Action 'tickets.open' is restricted on this API key.","permissions_mode":"restricted","request_id":"req_..."}

Authentication failures (missing, invalid, expired, or rate-limited key) return 401 with {"success":false,"error":"Invalid, expired, or rate-limited API key."}. A valid key that lacks a required scope, or is blocked by its permissions mode, returns 403.

Examples

JavaScript fetch

const res = await fetch('https://your-opsiq-domain.com/api/v1.php', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer opq_your_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    action: 'tickets.open',
    customer_email: '[email protected]',
    subject: 'Need help',
    body: 'The checkout page is failing.'
  })
});
const ticket = await res.json();

PHP cURL

$ch = curl_init('https://your-opsiq-domain.com/api/v1.php');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer opq_your_key_here',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => json_encode(['action' => 'crm.contacts.upsert', 'email' => '[email protected]', 'name' => 'Ada Lovelace']),
]);
$response = json_decode(curl_exec($ch), true);

Python requests

import requests

r = requests.post(
    'https://your-opsiq-domain.com/api/v1.php',
    headers={'Authorization': 'Bearer opq_your_key_here'},
    json={'action': 'crm.events.list', 'limit': 50},
    timeout=20,
)
r.raise_for_status()
print(r.json())