Skip to main content

admin.workflows.triggers.types.permissions.lookup method

This API method lists the permissions for using each trigger type. The response structure varies based on a toggle.

Usage info​

The output.properties.permissions structure returns different property sets depending on the toggle state:

Toggle OFF (default legacy behavior)​

When the toggle is OFF, each trigger type object contains:

  • permission (required): String enum of "everyone", "named_entities", or "no_one"
  • user_ids (conditional): Array of user IDs
  • team_ids (conditional): Array of team/workspace IDs
  • org_ids (conditional): Array of enterprise IDs

Validation Rule: If permission is set to "named_entities", then at least one of user_ids, team_ids, or org_ids must be present and non-empty.

Example Response:

{
  "permissions": {
    "Ftt01": {
      "permission": "named_entities",
      "user_ids": ["U00000001", "U00000002"],
      "team_ids": ["T00000001"]
    }
  },
  "metadata": { ... }
}

Toggle ON (granular permissions)​

When the toggle is ON, each trigger type object contains:

  • permissions (required): Array of permission objects

Each permission object in the array contains:

  • type (required): String enum specifying the permission type:
    • "trigger_type": Trigger access permission
    • "private_channel_access": Access to private channels
    • "private_channel_message_access": Access to text from messages in private channels
  • permission (required): String enum of "everyone", "named_entities", or "no_one"
  • user_ids (conditional): Array of user IDs
  • team_ids (conditional): Array of team/workspace IDs
  • org_ids (conditional): Array of enterprise IDs

Validation Rule: If permission is set to "named_entities" within any array item, then at least one of user_ids, team_ids, or org_ids must be present and non-empty for that item.

Example Response:

{
  "permissions": {
    "Ftt01": {
      "permissions": [
        {
          "type": "trigger_type",
          "permission": "everyone"
        },
        {
          "type": "private_channel_access",
          "permission": "named_entities",
          "team_ids": ["T00000001"]
        },
        {
          "type": "private_channel_message_access",
          "permission": "no_one"
        }
      ]
    }
  },
  "metadata": { ... }
}

Notes​

  • The toggle controls which response structure is returned.
  • Check for the presence of the permissions array to determine which format is being used.
  • The toggle ON format provides more granular control over different permission types.
  • Both formats maintain the same validation logic for named_entities requiring at least one entity ID list.

Response​