airflow-provider-braze 1.0.0

A Braze provider for Apache Airflow.

    

airflow-provider-braze

An Apache Airflow provider for Braze REST API.

---

Installation

pip install airflow-provider-braze

Requires Apache Airflow >= 2.9.0.

Connection Setup

In the Airflow UI, create a connection with:

Field	Value
Connection Type	Braze
Host	Your Braze REST endpoint (e.g. rest.iad-03.braze.com)
Password	Your Braze REST API key

Usage

from braze_provider.operators.braze_cdi import BrazeRunCDIJobOperator

sync_braze = BrazeRunCDIJobOperator(
    task_id="sync_braze_cdi",
    integration_id="your-integration-id",
    braze_conn_id="braze_default",
    poll_interval=30,
    timeout=3600,
    wait_for_completion=True,
)

Parameters

Parameter	Default	Description
integration_id	—	Braze CDI integration ID (templatable)
braze_conn_id	braze_default	Airflow connection ID
poll_interval	30	Seconds between status checks
timeout	3600	Max seconds to wait
wait_for_completion	True	Set False to trigger and move on

The operator returns the full job result dict via XCom, including rows_synced and rows_failed_with_errors.

Development

pyenv virtualenv 3.11 braze-provider
pyenv activate braze-provider
pip install -e .
pip install pytest
pytest tests/ -v

Contributing

Currently this provider only supports Cloud Data Ingestion (CDI). The BrazeHook wraps the Braze REST API and can be extended to support additional endpoints. Contributions are welcome — feel free to open a PR!

License

Apache 2.0