Issue Triggers

Issue Triggers

Issue triggers are the mechanism within Hookdeck to define which problems should trigger an issue (and a corresponding notification) and under which circumstances.

Behavior

Effective use of issue triggers relies on an understanding of their behavior and their relationship with the Issues they generate.

Generated Issues

Issues generated by an issue trigger are internally associated with that issue trigger.

  • You can view an issue trigger's associated issues by inspecting it.
  • Deleting an issue trigger will also delete all associated issues.
  • Updating an issue trigger will only affect generated issues after the update. Existing associated issues will be unaffected.

Notification Channels

Specify which channels (email, Slack, etc) should be used to notify you when an issue is triggered. To add a Notification Channel, read Projects Integrations.

Trigger Overlap

It is possible to have multiple issue triggers of a given type that overlap in their coverage. In such cases, Hookdeck will attempt to select the most specific trigger and apply its logic.

For instance, if you had two Delivery triggers and a given connection occurs in the connections list of both triggers, the longer of the two lists would be considered more specific and only the more specific trigger would run for that connection.

Issue Types

Issues are currently organized into three types -- delivery issues, transformation issues, and backpressure issues.

Delivery Issues

Delivery Issues describe issues related to the attempted delivery of requests, featuring two properties:

  • strategy : 'first_attempt_failure' or 'last_attempt_failure'
  • connections : a list of connections for which the trigger should be applied

Transformation Issues

Transformation Issues relate to issues that may occur in the data manipulation step of a request:

  • log_level : the log level where the issue should be opened -- 'warn', 'error', or 'fatal'
  • transformations : a list of transformations for which the trigger should be applied

Backpressure Issues

Backpressure Issues are caused when the estimated queue time (600,000ms, or 10 minutes, by default) exceeds the configured delay threshold. This allows for integration-specific alerts for impending queue processing issues.

  • delay : the queue backpressure, in milliseconds, that should trigger an issue
  • destinations : a list of destinations for which the trigger should be applied

Default Triggers

Each project is initialized with one issue trigger of each type:

  • The default Delivery issue trigger will alert on the first attempt failure of all connections.
  • The default Transformation issue trigger will alert for events on the warn log level of all transformations.
  • The default Backpressure issue trigger will alert when the estimated queue time exceeds the default delay of 600000ms (10 minutes) for all destinations.

View issue triggers

Viewing issue triggers gives you an overview of the issue types you'll receive notifications about when they occur in your project. Each issue trigger corresponds to a specific issue type and the details necessary to trigger a notification.

  1. Open the Issue Triggers page to see a list of all issue triggers, grouped by type.
GET /issue-triggers

Create an issue trigger

Creating an issue trigger tells Hookdeck the circumstances under which an issue notification should be sent.

  1. Open the Issues Triggers page to see a list of all issue triggers, grouped by type.
  2. Determine the desired trigger type and click the Create button in the corresponding section.
  3. Change the desired parameters for the given trigger's configuration.
  4. Click the Create Trigger button.
POST /issue-triggers

Inspect an issue trigger

Inspecting an issue trigger gives you access to its context and activation configuration.

  1. Find your issue trigger on the Issue Triggers page.
  2. Click the issue trigger's description.

From here you can view all issues associated with an issue trigger, update the parameters of the selected trigger, and define filters to better target and refine your notification strategy.

GET /issue-triggers/:id

Update an issue trigger

Updating an issue trigger's configuration lets you define the activation context for when notifications get sent out.

Updates made to an issue trigger apply only to notifications and issues generated after the update. Issues associated with the trigger prior to any changes will be unaffected.

  1. Find your issue trigger on the Issue Triggers page.
  2. Click the issue trigger's description to view the configuration.
  3. Change the desired parameters for the given trigger's configuration.
  4. Click Save for the configuration section to save the changes.
PUT /issue-triggers/:id

Delete an issue trigger

Deleting an issue trigger prevents it from generating notifications.

Deleting an issue trigger will also permanently delete all associated issues.

  1. Find your issue trigger on the Issue Triggers page.
  2. Click the issue trigger's description to view its configuration.
  3. Click Delete at the bottom of the page.
  4. Click Delete again to confirm.
DELETE /issue-triggers/:id
<- Previous Issues & Notifications Next -> Metrics