Django Action Triggers Documentation

Welcome to the documentation for Django Action Triggers (django-action-triggers), a flexible Django application that allows you to asynchronously trigger actions based on changes in the database.

Overview

In Django Action Triggers, a “trigger” refers to an event that initiates a corresponding “action”. Triggers are typically associated with database changes, such as creating, updating, or deleting records, while actions define the code that is executed in response to those changes.

Supported Actions

• Webhook Actions: Send HTTP requests to specified URLs when triggers are activated.

• Message Broker Actions: Send messages to messaging brokers like Kafka and RabbitMQ.

Key Features

• Database-Driven Triggers: Automatically trigger actions based on specific database changes, such as model save events.

• Flexible Action Handling: Integrate with a variety of external systems via webhooks and messaging brokers.

• Extensible: Easily extend to support custom triggers, actions, and integration points.

• Dynamic Configuration: Dynamically set values at runtime, allowing for secure and flexible handling of sensitive information.

Contents

This documentation is organised into the following sections:

• Installation
  • Prerequisites
  • Installation via PyPI
  • Next Steps
• Setup
  • Configuration
  • Migrations
• Action Trigger Settings
  • Overview
  • Configuration Options (ACTION_TRIGGERS)
  • Configuring Message Brokers (ACTION_TRIGGERS.brokers)
  • Configuring Webhooks (ACTION_TRIGGERS.webhooks)
  • Behavioural Settings (ACTION_TRIGGER_SETTINGS)
• API
  • Overview
  • Setup
  • Usage
  • Dynamic Value Assignment
  • Examples
• Dynamically Loading Values at Runtime
  • Usage
  • Setup
• Webhooks
  • Creating a Webhook Action
  • Dynamically Setting Headers
  • Best Practices
• Message Brokers
  • Configuration
  • Example Configuration
  • Best Practices for Configuration
  • Broker Configuration Guides
• Testing
  • Testing With tox
  • Testing With pytest
• Don’t See What You’re Looking For?

Message Broker Integrations

• Kafka
  • Configuration
  • Creating a Kafka Action
  • Dynamically Setting conn_details and parameters
• RabbitMQ
  • Configuration
  • Creating a RabbitMQ Action
  • Dynamically Setting conn_details and parameters
• Redis
  • Configuration
  • Creating a Redis Action
  • Dynamically Setting conn_details and parameters
• AWS SQS (AWS Simple Queue Service)
  • Configuration
  • Creating an AWS SQS Action
  • Dynamically Setting conn_details and parameters
• AWS SNS (AWS Simple Notification Service)
  • Configuration
  • Creating an AWS SNS Action
  • Dynamically Setting conn_details and parameters

Modules

• Module Documentation

Indices and tables

Use the following resources to quickly find what you’re looking for:

• Index

• Module Index

• Search Page

Additional Resources

For more information on specific topics, refer to the relevant sections of this documentation. If you encounter any issues or have questions, please raise an issue on the GitHub repository.