Result Types
Integrations can return different types of results to display information in various ways. Each result type has specific properties and use cases.
Available Result Types
1. Text Results
Simple text display for information, status messages, or data.
{
type: 'text',
content: 'Next deployment in 3h'
}
Text Result Preview
2. Link Results
Clickable links that navigate to external resources or perform actions.
{
type: 'link',
content: 'Oncall: John',
href: 'https://pagerduty.com/...',
icon: 'pagerduty',
}
Link Result Preview
3. Dropdown Results
Expandable menus with multiple related links or actions.
{
type: 'dropdown',
content: 'Deployed URLs',
items: [
{
type: 'link',
content: 'Staging - https://myservice.staging.myapp.com',
href: 'https://myservice.staging.myapp.com',
icon: 'link'
},
{
type: 'link',
content: 'PROD US - https://myservice.prod.us.myapp.com',
href: 'https://myservice.prod.us.myapp.com',
icon: 'link',
status: 'important',
},
{
type: 'link',
content: 'PROD EU - https://myservice.prod.eu.myapp.com',
href: 'https://myservice.prod.eu.myapp.com',
icon: 'link',
status: 'important',
}
]
}
Dropdown Result Preview
Status Values
Status indicators help users quickly understand the importance or state of results:
'important'- High priority, requires attention'relevant'- Contextually important'success'- Positive status or completion'none'- Default status
Open any dropdown below
Tooltips
Tooltips provide additional context and information when users hover over result items. They help explain what each item does or provides more details about the data being displayed.
Tooltip Properties
- Optional: All result types support an optional
tooltipfield - Length: Must be between 1 and 500 characters
- Display: Shown as native browser tooltips on hover
- Support: Available for text, link, dropdown, and dropdown item types
Examples
// Text with tooltip
{
type: 'text',
content: '3 alerts active',
status: 'important',
tooltip: 'Critical alerts requiring immediate attention'
}
Tooltip Result Preview - Move your mouse over the text
Icons
Icons provide visual context related to which tool the information comes from. Available icons include:
In every element you return as a result, you can add icon: 'icon-name' to display an icon.
Icon Result Preview
datadoggithubslackpagerdutycirclecijiraconfluencepostmanlinkcostlambdaawsaws-costlaunchdarklytjNext Steps
Now that you understand result types, learn about:
- When to Run - Controlling when integrations execute
- Caching - Optimizing performance
- Secrets - Managing configuration