Webhook Event Types
TapeAlert supports multiple types of events from Tape workflows. Understanding these event types helps you configure the right notifications for your specific needs.
Common Event Types
1. Workflow Errors
Event Type: workflow.error
or run.failed
These events are triggered when a Tape workflow encounters an error or fails to complete. They typically include:
- Error message details
- Workflow name and ID
- Run ID
- Timestamp of the error
- Links to the workflow and related records
2. Usage Notifications
Event Type: usage
Usage notifications provide information about your Tape account usage, such as:
- API usage limits
- Storage usage
- Rate limit warnings
3. Generic Errors
Event Type: error
General error events that don’t specifically relate to workflow failures.
4. Custom Events
Event Type: Various custom types
Tape allows you to trigger custom webhook events from your workflows. These can have any event type you define in your workflow.
Event Structure
Each event typically includes:
type
: The event type identifierorganization_name
: Your Tape organization nameworkflow_def_name
(for workflow events): The name of the workflowworkflow_def_url
(for workflow events): URL to the workflow in Tapeerror_message
(for error events): Details about what went wrongtriggered_on_record_url
(when applicable): URL to the record that triggered the workflow
Event Processing
TapeAlert processes these events and formats them appropriately for each notification destination:
- Email: Formatted emails with error details and direct links
- Google Spaces: Cards with key information and action buttons
- Microsoft Teams: Adaptive cards with workflow details
- Mattermost: Formatted messages with relevant links
- Linear: Issues with error details as description
Configuring Event-Specific Notifications
You can set up different notification destinations for different event types:
- Create multiple webhooks for your organization
- Add each webhook to different workflow types in Tape
- Configure specific notification destinations for each webhook
Testing Events
To test how different event types are processed:
- Go to your webhook details page
- Select “Test Webhook”
- Choose an event type to simulate
- Send the test event
- Check your notification destinations to see how the event was formatted